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 provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$workflowTemplateServiceClient = new WorkflowTemplateServiceClient();
try {
    $formattedParent = $workflowTemplateServiceClient->regionName('[PROJECT]', '[REGION]');
    $template = new WorkflowTemplate();
    $response = $workflowTemplateServiceClient->createWorkflowTemplate($formattedParent, $template);
} finally {
    $workflowTemplateServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\Dataproc\V1\Client\WorkflowTemplateServiceClient to use the new surface.

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Parameters
NameDescription
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.create, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

template Google\Cloud\Dataproc\V1\WorkflowTemplate

Required. The Dataproc workflow template to create.

optionalArgs 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
TypeDescription
Google\Cloud\Dataproc\V1\WorkflowTemplate
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\OrderedJob;
use Google\Cloud\Dataproc\V1\WorkflowTemplate;
use Google\Cloud\Dataproc\V1\WorkflowTemplatePlacement;
use Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient;

/**
 * @param string $formattedParent    The resource name of the region or location, as described
 *                                   in https://cloud.google.com/apis/design/resource_names.
 *
 *                                   * For `projects.regions.workflowTemplates.create`, the resource name of the
 *                                   region has the following format:
 *                                   `projects/{project_id}/regions/{region}`
 *
 *                                   * For `projects.locations.workflowTemplates.create`, the resource name of
 *                                   the location has the following format:
 *                                   `projects/{project_id}/locations/{location}`
 *                                   Please see {@see WorkflowTemplateServiceClient::regionName()} for help formatting this field.
 * @param string $templateId
 * @param string $templateJobsStepId The step id. The id must be unique among all jobs
 *                                   within the template.
 *
 *                                   The step id is used as prefix for job id, as job
 *                                   `goog-dataproc-workflow-step-id` label, and in
 *                                   [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids]
 *                                   field from other steps.
 *
 *                                   The id must contain only letters (a-z, A-Z), numbers (0-9),
 *                                   underscores (_), and hyphens (-). Cannot begin or end with underscore
 *                                   or hyphen. Must consist of between 3 and 50 characters.
 */
function create_workflow_template_sample(
    string $formattedParent,
    string $templateId,
    string $templateJobsStepId
): void {
    // Create a client.
    $workflowTemplateServiceClient = new WorkflowTemplateServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $templatePlacement = new WorkflowTemplatePlacement();
    $orderedJob = (new OrderedJob())
        ->setStepId($templateJobsStepId);
    $templateJobs = [$orderedJob,];
    $template = (new WorkflowTemplate())
        ->setId($templateId)
        ->setPlacement($templatePlacement)
        ->setJobs($templateJobs);

    // Call the API and handle any network failures.
    try {
        /** @var WorkflowTemplate $response */
        $response = $workflowTemplateServiceClient->createWorkflowTemplate($formattedParent, $template);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = WorkflowTemplateServiceClient::regionName('[PROJECT]', '[REGION]');
    $templateId = '[ID]';
    $templateJobsStepId = '[STEP_ID]';

    create_workflow_template_sample($formattedParent, $templateId, $templateJobsStepId);
}

deleteWorkflowTemplate

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

Parameters
NameDescription
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}

optionalArgs array

Optional.

↳ 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.

↳ 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.

Example
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient;

/**
 * @param string $formattedName 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 {@see WorkflowTemplateServiceClient::workflowTemplateName()} for help formatting this field.
 */
function delete_workflow_template_sample(string $formattedName): void
{
    // Create a client.
    $workflowTemplateServiceClient = new WorkflowTemplateServiceClient();

    // Call the API and handle any network failures.
    try {
        $workflowTemplateServiceClient->deleteWorkflowTemplate($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = WorkflowTemplateServiceClient::workflowTemplateName(
        '[PROJECT]',
        '[REGION]',
        '[WORKFLOW_TEMPLATE]'
    );

    delete_workflow_template_sample($formattedName);
}

getWorkflowTemplate

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Parameters
NameDescription
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.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

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

optionalArgs array

Optional.

↳ version int

Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved. If unspecified, retrieves the current version.

↳ 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
TypeDescription
Google\Cloud\Dataproc\V1\WorkflowTemplate
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\WorkflowTemplate;
use Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient;

/**
 * @param string $formattedName The resource name of the workflow template, as described
 *                              in https://cloud.google.com/apis/design/resource_names.
 *
 *                              * For `projects.regions.workflowTemplates.get`, the resource name of the
 *                              template has the following format:
 *                              `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
 *
 *                              * For `projects.locations.workflowTemplates.get`, the resource name of the
 *                              template has the following format:
 *                              `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
 *                              Please see {@see WorkflowTemplateServiceClient::workflowTemplateName()} for help formatting this field.
 */
function get_workflow_template_sample(string $formattedName): void
{
    // Create a client.
    $workflowTemplateServiceClient = new WorkflowTemplateServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var WorkflowTemplate $response */
        $response = $workflowTemplateServiceClient->getWorkflowTemplate($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = WorkflowTemplateServiceClient::workflowTemplateName(
        '[PROJECT]',
        '[REGION]',
        '[WORKFLOW_TEMPLATE]'
    );

    get_workflow_template_sample($formattedName);
}

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.

Parameters
NameDescription
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.

optionalArgs array

Optional.

↳ requestId 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.

↳ 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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataproc\V1\OrderedJob;
use Google\Cloud\Dataproc\V1\WorkflowTemplate;
use Google\Cloud\Dataproc\V1\WorkflowTemplatePlacement;
use Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    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 {@see WorkflowTemplateServiceClient::regionName()} for help formatting this field.
 * @param string $templateId
 * @param string $templateJobsStepId The step id. The id must be unique among all jobs
 *                                   within the template.
 *
 *                                   The step id is used as prefix for job id, as job
 *                                   `goog-dataproc-workflow-step-id` label, and in
 *                                   [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids]
 *                                   field from other steps.
 *
 *                                   The id must contain only letters (a-z, A-Z), numbers (0-9),
 *                                   underscores (_), and hyphens (-). Cannot begin or end with underscore
 *                                   or hyphen. Must consist of between 3 and 50 characters.
 */
function instantiate_inline_workflow_template_sample(
    string $formattedParent,
    string $templateId,
    string $templateJobsStepId
): void {
    // Create a client.
    $workflowTemplateServiceClient = new WorkflowTemplateServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $templatePlacement = new WorkflowTemplatePlacement();
    $orderedJob = (new OrderedJob())
        ->setStepId($templateJobsStepId);
    $templateJobs = [$orderedJob,];
    $template = (new WorkflowTemplate())
        ->setId($templateId)
        ->setPlacement($templatePlacement)
        ->setJobs($templateJobs);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $workflowTemplateServiceClient->instantiateInlineWorkflowTemplate(
            $formattedParent,
            $template
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = WorkflowTemplateServiceClient::regionName('[PROJECT]', '[REGION]');
    $templateId = '[ID]';
    $templateJobsStepId = '[STEP_ID]';

    instantiate_inline_workflow_template_sample($formattedParent, $templateId, $templateJobsStepId);
}

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.

Parameters
NameDescription
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}

optionalArgs array

Optional.

↳ 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.

↳ requestId 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

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

↳ 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
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName 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}`
 *                              Please see {@see WorkflowTemplateServiceClient::workflowTemplateName()} for help formatting this field.
 */
function instantiate_workflow_template_sample(string $formattedName): void
{
    // Create a client.
    $workflowTemplateServiceClient = new WorkflowTemplateServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $workflowTemplateServiceClient->instantiateWorkflowTemplate($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = WorkflowTemplateServiceClient::workflowTemplateName(
        '[PROJECT]',
        '[REGION]',
        '[WORKFLOW_TEMPLATE]'
    );

    instantiate_workflow_template_sample($formattedName);
}

listWorkflowTemplates

Lists workflows that match the specified filter in the request.

Parameters
NameDescription
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,list, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataproc\V1\WorkflowTemplate;
use Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient;

/**
 * @param string $formattedParent The resource name of the region or location, as described
 *                                in https://cloud.google.com/apis/design/resource_names.
 *
 *                                * For `projects.regions.workflowTemplates,list`, the resource
 *                                name of the region has the following format:
 *                                `projects/{project_id}/regions/{region}`
 *
 *                                * For `projects.locations.workflowTemplates.list`, the
 *                                resource name of the location has the following format:
 *                                `projects/{project_id}/locations/{location}`
 *                                Please see {@see WorkflowTemplateServiceClient::regionName()} for help formatting this field.
 */
function list_workflow_templates_sample(string $formattedParent): void
{
    // Create a client.
    $workflowTemplateServiceClient = new WorkflowTemplateServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $workflowTemplateServiceClient->listWorkflowTemplates($formattedParent);

        /** @var WorkflowTemplate $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = WorkflowTemplateServiceClient::regionName('[PROJECT]', '[REGION]');

    list_workflow_templates_sample($formattedParent);
}

updateWorkflowTemplate

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

Parameters
NameDescription
template Google\Cloud\Dataproc\V1\WorkflowTemplate

Required. The updated workflow template.

The template.version field must match the current version.

optionalArgs 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
TypeDescription
Google\Cloud\Dataproc\V1\WorkflowTemplate
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\OrderedJob;
use Google\Cloud\Dataproc\V1\WorkflowTemplate;
use Google\Cloud\Dataproc\V1\WorkflowTemplatePlacement;
use Google\Cloud\Dataproc\V1\WorkflowTemplateServiceClient;

/**
 * @param string $templateId
 * @param string $templateJobsStepId The step id. The id must be unique among all jobs
 *                                   within the template.
 *
 *                                   The step id is used as prefix for job id, as job
 *                                   `goog-dataproc-workflow-step-id` label, and in
 *                                   [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids]
 *                                   field from other steps.
 *
 *                                   The id must contain only letters (a-z, A-Z), numbers (0-9),
 *                                   underscores (_), and hyphens (-). Cannot begin or end with underscore
 *                                   or hyphen. Must consist of between 3 and 50 characters.
 */
function update_workflow_template_sample(string $templateId, string $templateJobsStepId): void
{
    // Create a client.
    $workflowTemplateServiceClient = new WorkflowTemplateServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $templatePlacement = new WorkflowTemplatePlacement();
    $orderedJob = (new OrderedJob())
        ->setStepId($templateJobsStepId);
    $templateJobs = [$orderedJob,];
    $template = (new WorkflowTemplate())
        ->setId($templateId)
        ->setPlacement($templatePlacement)
        ->setJobs($templateJobs);

    // Call the API and handle any network failures.
    try {
        /** @var WorkflowTemplate $response */
        $response = $workflowTemplateServiceClient->updateWorkflowTemplate($template);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $templateId = '[ID]';
    $templateJobsStepId = '[STEP_ID]';

    update_workflow_template_sample($templateId, $templateJobsStepId);
}

getOperationsClient

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

Returns
TypeDescription
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
NameDescription
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse

static::clusterRegionName

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

Parameters
NameDescription
project string
region string
cluster string
Returns
TypeDescription
stringThe formatted cluster_region resource.

static::locationName

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

Parameters
NameDescription
project string
location string
Returns
TypeDescription
stringThe formatted location resource.

static::nodeGroupName

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

Parameters
NameDescription
project string
region string
cluster string
nodeGroup string
Returns
TypeDescription
stringThe formatted node_group resource.

static::projectLocationWorkflowTemplateName

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

Parameters
NameDescription
project string
location string
workflowTemplate string
Returns
TypeDescription
stringThe 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
NameDescription
project string
region string
workflowTemplate string
Returns
TypeDescription
stringThe formatted project_region_workflow_template resource.

static::regionName

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

Parameters
NameDescription
project string
region string
Returns
TypeDescription
stringThe formatted region resource.

static::serviceName

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

Parameters
NameDescription
project string
location string
service string
Returns
TypeDescription
stringThe formatted service resource.

static::workflowTemplateName

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

Parameters
NameDescription
project string
region string
workflowTemplate string
Returns
TypeDescription
stringThe 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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.dataproc.v1.WorkflowTemplateService'

The name of the service.

SERVICE_ADDRESS

Value: 'dataproc.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.