Google Cloud Dataproc V1 Client - Class DeleteWorkflowTemplateRequest (3.10.1)

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

A request to delete a workflow template.

Currently started workflows will remain running.

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

Namespace

Google \ Cloud \ Dataproc \ V1

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.delete`, 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 delete. If specified, will only delete the template if the current server version matches specified version.

getName

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

For projects.regions.workflowTemplates.delete, 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.delete, 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 delete. If specified, will only delete the template if the current server version matches specified version.

Returns
Type	Description
`int`

setVersion

Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

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.delete, 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} Please see Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient::workflowTemplateName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Dataproc\V1\DeleteWorkflowTemplateRequest`