Google Cloud Workflows V1beta Client - Class WorkflowsClient (0.3.0)

Reference documentation and code samples for the Google Cloud Workflows V1beta Client class WorkflowsClient.

Service Description: Workflows is used to deploy and execute workflow programs.

Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

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:

$workflowsClient = new WorkflowsClient();
try {
    $formattedParent = $workflowsClient->locationName('[PROJECT]', '[LOCATION]');
    $workflow = new Workflow();
    $workflowId = 'workflow_id';
    $operationResponse = $workflowsClient->createWorkflow($formattedParent, $workflow, $workflowId);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $workflowsClient->createWorkflow($formattedParent, $workflow, $workflowId);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $workflowsClient->resumeOperation($operationName, 'createWorkflow');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $workflowsClient->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.

Namespace

Google \ Cloud \ Workflows \ V1beta

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.

createWorkflow

Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.

Parameters
Name	Description
`parent`	`string` Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}
`workflow`	`Google\Cloud\Workflows\V1beta\Workflow` Required. Workflow to be created.
`workflowId`	`string` Required. The ID of the workflow to be created. It has to fulfill the following requirements: Must contain only letters, numbers, underscores and hyphens. Must start with a letter. Must be between 1-64 characters. Must end with a number or a letter. Must be unique within the customer project and location.
`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
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Workflows\V1beta\Workflow;
use Google\Cloud\Workflows\V1beta\WorkflowsClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent Project and location in which the workflow should be created.
 *                                Format:  projects/{project}/locations/{location}
 *                                Please see {@see WorkflowsClient::locationName()} for help formatting this field.
 * @param string $workflowId      The ID of the workflow to be created. It has to fulfill the
 *                                following requirements:
 *
 *                                * Must contain only letters, numbers, underscores and hyphens.
 *                                * Must start with a letter.
 *                                * Must be between 1-64 characters.
 *                                * Must end with a number or a letter.
 *                                * Must be unique within the customer project and location.
 */
function create_workflow_sample(string $formattedParent, string $workflowId): void
{
    // Create a client.
    $workflowsClient = new WorkflowsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $workflow = new Workflow();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $workflowsClient->createWorkflow($formattedParent, $workflow, $workflowId);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Workflow $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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 = WorkflowsClient::locationName('[PROJECT]', '[LOCATION]');
    $workflowId = '[WORKFLOW_ID]';

    create_workflow_sample($formattedParent, $workflowId);
}

deleteWorkflow

Deletes a workflow with the specified name.

This method also cancels and deletes all running executions of the workflow.

Parameters
Name	Description
`name`	`string` Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}
`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
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Workflows\V1beta\WorkflowsClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the workflow to be deleted.
 *                              Format: projects/{project}/locations/{location}/workflows/{workflow}
 *                              Please see {@see WorkflowsClient::workflowName()} for help formatting this field.
 */
function delete_workflow_sample(string $formattedName): void
{
    // Create a client.
    $workflowsClient = new WorkflowsClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $workflowsClient->deleteWorkflow($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 = WorkflowsClient::workflowName('[PROJECT]', '[LOCATION]', '[WORKFLOW]');

    delete_workflow_sample($formattedName);
}

getWorkflow

Gets details of a single Workflow.

Parameters
Name	Description
`name`	`string` Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}
`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
Type	Description
`Google\Cloud\Workflows\V1beta\Workflow`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Workflows\V1beta\Workflow;
use Google\Cloud\Workflows\V1beta\WorkflowsClient;

/**
 * @param string $formattedName Name of the workflow which information should be retrieved.
 *                              Format: projects/{project}/locations/{location}/workflows/{workflow}
 *                              Please see {@see WorkflowsClient::workflowName()} for help formatting this field.
 */
function get_workflow_sample(string $formattedName): void
{
    // Create a client.
    $workflowsClient = new WorkflowsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Workflow $response */
        $response = $workflowsClient->getWorkflow($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 = WorkflowsClient::workflowName('[PROJECT]', '[LOCATION]', '[WORKFLOW]');

    get_workflow_sample($formattedName);
}

listWorkflows

Lists Workflows in a given project and location.

The default order is not specified.

Parameters
Name	Description
`parent`	`string` Required. Project and location from which the workflows should be listed. Format: projects/{project}/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.
`↳ filter`	`string` Filter to restrict results to specific workflows.
`↳ orderBy`	`string` Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Workflows\V1beta\Workflow;
use Google\Cloud\Workflows\V1beta\WorkflowsClient;

/**
 * @param string $formattedParent Project and location from which the workflows should be listed.
 *                                Format: projects/{project}/locations/{location}
 *                                Please see {@see WorkflowsClient::locationName()} for help formatting this field.
 */
function list_workflows_sample(string $formattedParent): void
{
    // Create a client.
    $workflowsClient = new WorkflowsClient();

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

        /** @var Workflow $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 = WorkflowsClient::locationName('[PROJECT]', '[LOCATION]');

    list_workflows_sample($formattedParent);
}

updateWorkflow

Updates an existing workflow.

Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.

Parameters
Name	Description
`workflow`	`Google\Cloud\Workflows\V1beta\Workflow` Required. Workflow to be updated.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` List of fields to be updated. If not present, the entire workflow will be updated.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Workflows\V1beta\Workflow;
use Google\Cloud\Workflows\V1beta\WorkflowsClient;
use Google\Rpc\Status;

/**
 * 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 update_workflow_sample(): void
{
    // Create a client.
    $workflowsClient = new WorkflowsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $workflow = new Workflow();

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

        if ($response->operationSucceeded()) {
            /** @var Workflow $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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());
    }
}

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::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::workflowName

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

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

Returns
Type	Description
`string`	The formatted workflow 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

location: projects/{project}/locations/{location}
workflow: projects/{project}/locations/{location}/workflows/{workflow}

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.

Constants

SERVICE_NAME

Value: 'google.cloud.workflows.v1beta.Workflows'

The name of the service.

SERVICE_ADDRESS

Value: 'workflows.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.