Google Cloud Dataform V1 Client - Class WorkflowInvocation (0.9.0)

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

Represents a single invocation of a compilation result.

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

Namespace

Google \ Cloud \ Dataform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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/`.
`↳ name`	`string` Output only. The workflow invocation's name.
`↳ invocation_config`	`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.
`↳ resolved_compilation_result`	`string` Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects//locations//repositories//compilationResults/`.
`↳ data_encryption_state`	`DataEncryptionState` Output only. Only set if the repository has a KMS Key.
`↳ 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.

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`

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`

getInvocationConfig

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

Returns
Type	Description
`InvocationConfig\|null`

hasInvocationConfig

clearInvocationConfig

setInvocationConfig

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

Parameter
Name	Description
`var`	`InvocationConfig`

Returns
Type	Description
`$this`

getState

Output only. This workflow invocation's current state.

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. This workflow invocation's current state.

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$this`

getInvocationTiming

Output only. This workflow invocation's timing details.

Returns
Type	Description
`Google\Type\Interval\|null`

hasInvocationTiming

clearInvocationTiming

setInvocationTiming