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 messagegoogle.cloud.dataform.v1beta1.WorkflowInvocation
Namespace
Google \ Cloud \ Dataform \ V1beta1
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 formatprojects/*/locations/*/repositories/*/compilationResults/*.
↳ workflow_config
string
Immutable. The name of the workflow config to invoke. Must be in the formatprojects/*/locations/*/repositories/*/workflowConfigs/*.
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 formatprojects/*/locations/*/repositories/*/compilationResults/*.
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 formatprojects/*/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 formatprojects/*/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
formatprojects/*/locations/*/repositories/*/workflowConfigs/*.
Returns
Type
Description
string
hasWorkflowConfig
setWorkflowConfig
Immutable. The name of the workflow config to invoke. Must be in the
formatprojects/*/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.
Output only. The resolved compilation result that was used to create this
invocation. Will be in the formatprojects/*/locations/*/repositories/*/compilationResults/*.
Returns
Type
Description
string
setResolvedCompilationResult
Output only. The resolved compilation result that was used to create this
invocation. Will be in the formatprojects/*/locations/*/repositories/*/compilationResults/*.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDataEncryptionState
Output only. Only set if the repository has a KMS Key.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataform V1beta1 Client - Class WorkflowInvocation (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dataform/latest/V1beta1.WorkflowInvocation)\n- [0.8.0](/php/docs/reference/cloud-dataform/0.8.0/V1beta1.WorkflowInvocation)\n- [0.7.0](/php/docs/reference/cloud-dataform/0.7.0/V1beta1.WorkflowInvocation)\n- [0.6.0](/php/docs/reference/cloud-dataform/0.6.0/V1beta1.WorkflowInvocation)\n- [0.5.1](/php/docs/reference/cloud-dataform/0.5.1/V1beta1.WorkflowInvocation)\n- [0.4.7](/php/docs/reference/cloud-dataform/0.4.7/V1beta1.WorkflowInvocation)\n- [0.3.0](/php/docs/reference/cloud-dataform/0.3.0/V1beta1.WorkflowInvocation)\n- [0.2.3](/php/docs/reference/cloud-dataform/0.2.3/V1beta1.WorkflowInvocation)\n- [0.1.6](/php/docs/reference/cloud-dataform/0.1.6/V1beta1.WorkflowInvocation) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Dataform V1beta1 Client class WorkflowInvocation.\n\nRepresents a single invocation of a compilation result.\n\nGenerated from protobuf message `google.cloud.dataform.v1beta1.WorkflowInvocation`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataform \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCompilationResult\n\nImmutable. The name of the compilation result to use for this invocation.\n\nMust be in the format\n`projects/*/locations/*/repositories/*/compilationResults/*`.\n\n### hasCompilationResult\n\n### setCompilationResult\n\nImmutable. The name of the compilation result to use for this invocation.\n\nMust be in the format\n`projects/*/locations/*/repositories/*/compilationResults/*`.\n\n### getWorkflowConfig\n\nImmutable. The name of the workflow config to invoke. Must be in the\nformat `projects/*/locations/*/repositories/*/workflowConfigs/*`.\n\n### hasWorkflowConfig\n\n### setWorkflowConfig\n\nImmutable. The name of the workflow config to invoke. Must be in the\nformat `projects/*/locations/*/repositories/*/workflowConfigs/*`.\n\n### getName\n\nOutput only. The workflow invocation's name.\n\n### setName\n\nOutput only. The workflow invocation's name.\n\n### getInvocationConfig\n\nImmutable. If left unset, a default InvocationConfig will be used.\n\n### hasInvocationConfig\n\n### clearInvocationConfig\n\n### setInvocationConfig\n\nImmutable. If left unset, a default InvocationConfig will be used.\n\n### getState\n\nOutput only. This workflow invocation's current state.\n\n### setState\n\nOutput only. This workflow invocation's current state.\n\n### getInvocationTiming\n\nOutput only. This workflow invocation's timing details.\n\n### hasInvocationTiming\n\n### clearInvocationTiming\n\n### setInvocationTiming\n\nOutput only. This workflow invocation's timing details.\n\n### getResolvedCompilationResult\n\nOutput only. The resolved compilation result that was used to create this\ninvocation. Will be in the format\n`projects/*/locations/*/repositories/*/compilationResults/*`.\n\n### setResolvedCompilationResult\n\nOutput only. The resolved compilation result that was used to create this\ninvocation. Will be in the format\n`projects/*/locations/*/repositories/*/compilationResults/*`.\n\n### getDataEncryptionState\n\nOutput only. Only set if the repository has a KMS Key.\n\n### hasDataEncryptionState\n\n### clearDataEncryptionState\n\n### setDataEncryptionState\n\nOutput only. Only set if the repository has a KMS Key.\n\n### getInternalMetadata\n\nOutput only. All the metadata information that is used internally to serve\nthe resource. For example: timestamps, flags, status fields, etc. The\nformat of this field is a JSON string.\n\n### hasInternalMetadata\n\n### clearInternalMetadata\n\n### setInternalMetadata\n\nOutput only. All the metadata information that is used internally to serve\nthe resource. For example: timestamps, flags, status fields, etc. The\nformat of this field is a JSON string.\n\n### getCompilationSource"]]
