Google Cloud Dataproc V1 Client - Class InstantiateInlineWorkflowTemplateRequest (2.2.0)

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

A request to instantiate an inline workflow template.

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} * For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
↳ template Google\Cloud\Dataproc\V1\WorkflowTemplate

Required. The workflow template to instantiate.
↳ 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.

getParent

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

  • For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region}
  • For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
Returns
Type Description
string

setParent

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

  • For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region}
  • For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
Parameter
Name Description
var string
Returns
Type Description
$this

getTemplate

Required. The workflow template to instantiate.

Returns
Type Description
Google\Cloud\Dataproc\V1\WorkflowTemplate|null

hasTemplate

clearTemplate

setTemplate

Required. The workflow template to instantiate.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\WorkflowTemplate
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

static::build

Parameters
Name Description
parent string

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

  • For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} Please see Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient::regionName() for help formatting this field.
template Google\Cloud\Dataproc\V1\WorkflowTemplate

Required. The workflow template to instantiate.
Returns
Type Description
Google\Cloud\Dataproc\V1\InstantiateInlineWorkflowTemplateRequest