AutomationBuilder

@AutomationDsl
class AutomationBuilder

Type-safe builder that builds an Automation node.

Summary

Public constructors
`AutomationBuilder()`

Public functions
`BaseAutomation`	`build()` Build an `Automation`.
`() -> Unit`	`description(description: String)` Set the `description`.
`() -> Unit`	`isActive(isActive: Boolean)` Set `isActive`.
`Unit`	`managingAppDisplayNames(managingAppDisplayNames: List<LocalizedText>)` Set `managingAppDisplayNames`.
`() -> Unit`	`maxExecutionCount(maxExecutionCount: Int?)` Set `maxExecutionCount`.
`Unit`	`name(name: String)` Set the `name`.
`Unit`	`sequential(block: SequentialFlowBuilder.() -> Unit)` Build and add a `sequentialFlow`.
`Unit`	`sequential(sequentialFlow: SequentialFlow)` Set the `sequentialFlow`.

Public properties
`AutomationSourceMetadata?`	`automationSourceMetadata` Metadata about the source of the automation.
`String?`	`clientFeatureGroup` Unique identifier of the client feature group that the automation belongs to.
`String`	`description` The description of the automation.
`Boolean`	`isActive` Whether or not the automation is active.
`Boolean`	`isRunning` Whether or not the automation is running.
`List<LocalizedText>`	`managingAppDisplayNames` Localized human readable names of the managing applications.
`String`	`name` The name of the automation, must be specified and not empty.

Public constructors

AutomationBuilder

AutomationBuilder()

Public functions

build

fun build(): BaseAutomation

Build an Automation.

Returns
`BaseAutomation`	An `Automation` instance.

description

fun description(description: String): () -> Unit

Set the description.

Parameters
`description: String`	The description of the `SequentialFlow`.

isActive

fun isActive(isActive: Boolean): () -> Unit

Set isActive.

Parameters
`isActive: Boolean`	Set the `isActive` flag.

managingAppDisplayNames

fun managingAppDisplayNames(managingAppDisplayNames: List<LocalizedText>): Unit

Set managingAppDisplayNames.

Parameters
`managingAppDisplayNames: List<LocalizedText>`	Set the `managingAppDisplayNames` value.

maxExecutionCount

fun maxExecutionCount(maxExecutionCount: Int?): () -> Unit

Set maxExecutionCount.

Parameters
`maxExecutionCount: Int?`	Set the `maxExecutionCount` value.

name

fun name(name: String): Unit

Set the name.

Parameters
`name: String`	The name of the `SequentialFlow`.

sequential

fun sequential(block: SequentialFlowBuilder.() -> Unit): Unit

Build and add a sequentialFlow.

Parameters
`block: SequentialFlowBuilder.() -> Unit`	The `SequentialFlowBuilder` used to build the `SequentialFlow`.

sequential

fun sequential(sequentialFlow: SequentialFlow): Unit

Set the sequentialFlow.

Parameters
`sequentialFlow: SequentialFlow`	The primary `SequentialFlow` in the `Automation`.

Public properties

automationSourceMetadata

var automationSourceMetadata: AutomationSourceMetadata?

Metadata about the source of the automation. For blueprint suggestions, this will contain the ID of the blueprint the suggestion was generated from.

clientFeatureGroup

var clientFeatureGroup: String?

Unique identifier of the client feature group that the automation belongs to. This is used to group automations for specific client features (e.g. 3P settings-based automations).

description

var description: String

The description of the automation.

isActive

var isActive: Boolean

Whether or not the automation is active. true by default.

isRunning

var isRunning: Boolean

Whether or not the automation is running. false by default.

managingAppDisplayNames

var managingAppDisplayNames: List<LocalizedText>

Localized human readable names of the managing applications.

name

var name: String

The name of the automation, must be specified and not empty.