Google Cloud Dataform V1 Client - Class WorkflowConfig (0.9.1)

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

Represents a Dataform workflow configuration.

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

Namespace

Google \ Cloud \ Dataform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. 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 descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
↳ disabled bool

Optional. Disables automatic creation of workflow invocations.
↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp of when the WorkflowConfig was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The timestamp of when the WorkflowConfig was last updated.
↳ internal_metadata string

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

getName

Identifier. The workflow config's name.

Returns
Type Description
string

setName

Identifier. 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

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getRecentScheduledExecutionRecords

Output only. Records of the 10 most recent scheduled execution attempts, ordered 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

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

Parameter
Name Description
var array<WorkflowConfig\ScheduledExecutionRecord>
Returns
Type Description
$this

getDisabled

Optional. Disables automatic creation of workflow invocations.

Returns
Type Description
bool

setDisabled

Optional. Disables automatic creation of workflow invocations.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCreateTime

Output only. The timestamp of when the WorkflowConfig was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp of when the WorkflowConfig was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The timestamp of when the WorkflowConfig was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp of when the WorkflowConfig was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getInternalMetadata

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

Returns
Type Description
string

hasInternalMetadata

clearInternalMetadata

setInternalMetadata

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

Parameter
Name Description
var string
Returns
Type Description
$this