Google Cloud Dataform V1beta1 Client - Class WorkflowInvocation (0.3.0)

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
NameDescription
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
TypeDescription
string

setName

Output only. The workflow invocation's name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCompilationResult

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

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

Returns
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getWorkflowConfig

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

Returns
TypeDescription
string

hasWorkflowConfig

setWorkflowConfig

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInvocationConfig

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

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\InvocationConfig|null

hasInvocationConfig

clearInvocationConfig

setInvocationConfig

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

Parameter
NameDescription
var Google\Cloud\Dataform\V1beta1\InvocationConfig
Returns
TypeDescription
$this

getState

Output only. This workflow invocation's current state.

Returns
TypeDescription
int

setState

Output only. This workflow invocation's current state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getInvocationTiming

Output only. This workflow invocation's timing details.

Returns
TypeDescription
Google\Type\Interval|null

hasInvocationTiming

clearInvocationTiming

setInvocationTiming

Output only. This workflow invocation's timing details.

Parameter
NameDescription
var Google\Type\Interval
Returns
TypeDescription
$this

getCompilationSource

Returns
TypeDescription
string