generateDsl

Summary

Generates a domain-specific language (DSL) script for the specified object including all nested objects, parameters, and custom properties, subject to arguments passed in with the command.

path

Stringrequired

A property path indicating a single object for which DSL will be generated.

format

Stringoptional

Format to use for the DSL. Defaults to groovy format.

Possible values: "groovy", "yaml"

includeChildren

Stringoptional

A comma-separated list of collection types to include in generated DSL, all other children will be suppressed.

suppressChildren

Booleanoptional

True to suppress all child entities in the generated DSL for the object.

suppressDefaults

Booleanoptional

True to suppress system default in the generated DSL for the object.

suppressEmpty

Booleanoptional

True to suppress properties with empty values in the generated DSL for the object.

suppressNulls

Booleanoptional

True to suppress properties with null values in the generated DSL for the object.

suppressParent

Booleanoptional

True to remove object parent reference from DSL output.

suppressParentAcl

Booleanoptionalpreview

True to suppress the parent ACL when generating ACLs for child objects. Use only if withAcls argument equals True.

useFileReferences

Booleanoptional

True to replace specific properties with file references.

withAcls

Booleanoptional

True to emit ACLs in the generated DSL for the object.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.generateDsl(
  path: "test-path"
  /* optional arguments */
)▼