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 \ V1beta1Methods
__construct
Constructor.
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
↳ 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
↳ update_time
↳ 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.
string
setName
Identifier. The workflow config's name.
var
string
$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/*
.
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/*
.
var
string
$this
getInvocationConfig
Optional. If left unset, a default InvocationConfig will be used.
hasInvocationConfig
clearInvocationConfig
setInvocationConfig
Optional. If left unset, a default InvocationConfig will be used.
$this
getCronSchedule
Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
string
setCronSchedule
Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
var
string
$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.
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.
var
string
$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.
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.
$this
getDisabled
Optional. Disables automatic creation of workflow invocations.
bool
setDisabled
Optional. Disables automatic creation of workflow invocations.
var
bool
$this
getCreateTime
Output only. The timestamp of when the WorkflowConfig was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp of when the WorkflowConfig was created.
$this
getUpdateTime
Output only. The timestamp of when the WorkflowConfig was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp of when the WorkflowConfig was last updated.
$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.
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.
var
string
$this
