Google Cloud Dataform V1beta1 Client - Class WorkflowInvocation (0.4.5)

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

Represents a single invocation of a compilation result.

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

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 invocation's name.

↳ compilation_result string

Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.

↳ workflow_config string

Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.

↳ invocation_config Google\Cloud\Dataform\V1beta1\InvocationConfig

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

↳ state int

Output only. This workflow invocation's current state.

↳ invocation_timing Google\Type\Interval

Output only. This workflow invocation's timing details.

getName

Output only. The workflow invocation's name.

Returns
Type Description
string

setName

Output only. The workflow invocation's name.

Parameter
Name Description
var string
Returns
Type Description
$this

getCompilationResult

Immutable. The name of the compilation result to use for this invocation.

Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.

Returns
Type Description
string

hasCompilationResult

setCompilationResult

Immutable. The name of the compilation result to use for this invocation.

Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkflowConfig

Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.

Returns
Type Description
string

hasWorkflowConfig

setWorkflowConfig

Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getInvocationConfig

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

Returns
Type Description
Google\Cloud\Dataform\V1beta1\InvocationConfig|null

hasInvocationConfig

clearInvocationConfig

setInvocationConfig

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

Parameter
Name Description
var Google\Cloud\Dataform\V1beta1\InvocationConfig
Returns
Type Description
$this

getState

Output only. This workflow invocation's current state.

Returns
Type Description
int

setState

Output only. This workflow invocation's current state.

Parameter
Name Description
var int
Returns
Type Description
$this

getInvocationTiming

Output only. This workflow invocation's timing details.

Returns
Type Description
Google\Type\Interval|null

hasInvocationTiming

clearInvocationTiming

setInvocationTiming

Output only. This workflow invocation's timing details.

Parameter
Name Description
var Google\Type\Interval
Returns
Type Description
$this

getCompilationSource

Returns
Type Description
string