Google Cloud Dataform V1beta1 Client - Class WorkflowConfig (0.4.6)

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class WorkflowConfig.

Represents a Dataform workflow configuration.

Generated from protobuf message google.cloud.dataform.v1beta1.WorkflowConfig

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The workflow config's name.
`↳ release_config`	`string` Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects//locations//repositories//releaseConfigs/`.
`↳ invocation_config`	`InvocationConfig` Optional. If left unset, a default InvocationConfig will be used.
`↳ cron_schedule`	`string` Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
`↳ time_zone`	`string` Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
`↳ recent_scheduled_execution_records`	`array<WorkflowConfig\ScheduledExecutionRecord>` Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

getName

Output only. The workflow config's name.

Returns
Type	Description
`string`

setName

Output only. The workflow config's name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReleaseConfig

Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

Returns
Type	Description
`string`

setReleaseConfig

Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInvocationConfig

Optional. If left unset, a default InvocationConfig will be used.

Returns
Type	Description
`InvocationConfig\|null`

hasInvocationConfig

clearInvocationConfig

setInvocationConfig

Optional. If left unset, a default InvocationConfig will be used.

Parameter
Name	Description
`var`	`InvocationConfig`

Returns
Type	Description
`$this`

getCronSchedule

Optional. Optional schedule (in cron format) for automatic execution of this workflow config.

Returns
Type	Description
`string`

setCronSchedule

Optional. Optional schedule (in cron format) for automatic execution of this workflow config.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTimeZone

Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

Returns
Type	Description
`string`

setTimeZone

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRecentScheduledExecutionRecords

Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setRecentScheduledExecutionRecords

Parameter
Name	Description
`var`	`array<WorkflowConfig\ScheduledExecutionRecord>`

Returns
Type	Description
`$this`