Google Cloud Dataproc V1 Client - Class WorkflowTemplateServiceClient (3.8.1)

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

Service Description: The API interface for managing Workflow Templates in the Dataproc API.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Dataproc \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createWorkflowTemplate

Creates new workflow template.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::createWorkflowTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\CreateWorkflowTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

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

deleteWorkflowTemplate

Deletes a workflow template. It does not cancel in-progress workflows.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::deleteWorkflowTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\DeleteWorkflowTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getWorkflowTemplate

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::getWorkflowTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\GetWorkflowTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

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

instantiateInlineWorkflowTemplate

Instantiates a template and begins execution.

This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.

The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The Operation.metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, Operation.response will be Empty.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::instantiateInlineWorkflowTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\InstantiateInlineWorkflowTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

instantiateWorkflowTemplate

Instantiates a template and begins execution.

The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The Operation.metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, Operation.response will be Empty.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::instantiateWorkflowTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\InstantiateWorkflowTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

listWorkflowTemplates

Lists workflows that match the specified filter in the request.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::listWorkflowTemplatesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\ListWorkflowTemplatesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateWorkflowTemplate

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::updateWorkflowTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\UpdateWorkflowTemplateRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

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

createWorkflowTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\CreateWorkflowTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteWorkflowTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\DeleteWorkflowTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getWorkflowTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\GetWorkflowTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

instantiateInlineWorkflowTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\InstantiateInlineWorkflowTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

instantiateWorkflowTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\InstantiateWorkflowTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listWorkflowTemplatesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\ListWorkflowTemplatesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateWorkflowTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\UpdateWorkflowTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::clusterRegionName

Formats a string containing the fully-qualified path to represent a cluster_region resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`cluster`	`string`

Returns
Type	Description
`string`	The formatted cluster_region resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::nodeGroupName

Formats a string containing the fully-qualified path to represent a node_group resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`cluster`	`string`
`nodeGroup`	`string`

Returns
Type	Description
`string`	The formatted node_group resource.

static::projectLocationWorkflowTemplateName

Formats a string containing the fully-qualified path to represent a project_location_workflow_template resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`workflowTemplate`	`string`

Returns
Type	Description
`string`	The formatted project_location_workflow_template resource.

static::projectRegionWorkflowTemplateName

Formats a string containing the fully-qualified path to represent a project_region_workflow_template resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`workflowTemplate`	`string`

Returns
Type	Description
`string`	The formatted project_region_workflow_template resource.

static::regionName

Formats a string containing the fully-qualified path to represent a region resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`

Returns
Type	Description
`string`	The formatted region resource.

static::serviceName

Formats a string containing the fully-qualified path to represent a service resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted service resource.

static::workflowTemplateName

Formats a string containing the fully-qualified path to represent a workflow_template resource.

Parameters
Name	Description
`project`	`string`
`region`	`string`
`workflowTemplate`	`string`

Returns
Type	Description
`string`	The formatted workflow_template resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

clusterRegion: projects/{project}/regions/{region}/clusters/{cluster}
location: projects/{project}/locations/{location}
nodeGroup: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{node_group}
projectLocationWorkflowTemplate: projects/{project}/locations/{location}/workflowTemplates/{workflow_template}
projectRegionWorkflowTemplate: projects/{project}/regions/{region}/workflowTemplates/{workflow_template}
region: projects/{project}/regions/{region}
service: projects/{project}/locations/{location}/services/{service}
workflowTemplate: projects/{project}/regions/{region}/workflowTemplates/{workflow_template}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.