Google Cloud Dataproc V1 Client - Class InstantiateWorkflowTemplateRequest (3.3.0)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class InstantiateWorkflowTemplateRequest.

A request to instantiate a workflow template.

Generated from protobuf message google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
`↳ version`	`int` Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version. This option cannot be used to instantiate a previous version of workflow template.
`↳ request_id`	`string` Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries. It is recommended to always set this value to a UUID. The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
`↳ parameters`	`array\|Google\Protobuf\Internal\MapField` Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.

getName

Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

Returns
Type	Description
`string`

setName

Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVersion

Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.

This option cannot be used to instantiate a previous version of workflow template.

Returns
Type	Description
`int`

setVersion

Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.

This option cannot be used to instantiate a previous version of workflow template.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRequestId

Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.

It is recommended to always set this value to a UUID. The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Returns
Type	Description
`string`

setRequestId

Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.

It is recommended to always set this value to a UUID. The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParameters

Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setParameters

Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`