Google Cloud Workflows V1beta Client - Class ExecutionsClient (0.2.17)

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

Service Description: Executions is used to start and manage running instances of Workflows called executions.

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:

$executionsClient = new ExecutionsClient();
try {
    $formattedName = $executionsClient->executionName('[PROJECT]', '[LOCATION]', '[WORKFLOW]', '[EXECUTION]');
    $response = $executionsClient->cancelExecution($formattedName);
} finally {
    $executionsClient->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 \ Executions \ 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.

cancelExecution

Cancels an execution of the given name.

Sample code:

$executionsClient = new ExecutionsClient();
try {
    $formattedName = $executionsClient->executionName('[PROJECT]', '[LOCATION]', '[WORKFLOW]', '[EXECUTION]');
    $response = $executionsClient->cancelExecution($formattedName);
} finally {
    $executionsClient->close();
}

Parameters
Name	Description
`name`	`string` Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
`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\Executions\V1beta\Execution`

createExecution

Creates a new execution using the latest revision of the given workflow.

Sample code:

$executionsClient = new ExecutionsClient();
try {
    $formattedParent = $executionsClient->workflowName('[PROJECT]', '[LOCATION]', '[WORKFLOW]');
    $execution = new Execution();
    $response = $executionsClient->createExecution($formattedParent, $execution);
} finally {
    $executionsClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.
`execution`	`Google\Cloud\Workflows\Executions\V1beta\Execution` Required. Execution to be created.
`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\Executions\V1beta\Execution`

getExecution

Returns an execution of the given name.

Sample code:

$executionsClient = new ExecutionsClient();
try {
    $formattedName = $executionsClient->executionName('[PROJECT]', '[LOCATION]', '[WORKFLOW]', '[EXECUTION]');
    $response = $executionsClient->getExecution($formattedName);
} finally {
    $executionsClient->close();
}

Parameters
Name	Description
`name`	`string` Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
`optionalArgs`	`array` Optional.
`↳ view`	`int` Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view. For allowed values, use constants defined on Google\Cloud\Workflows\Executions\V1beta\ExecutionView
`↳ 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\Executions\V1beta\Execution`

listExecutions

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

Sample code:

$executionsClient = new ExecutionsClient();
try {
    $formattedParent = $executionsClient->workflowName('[PROJECT]', '[LOCATION]', '[WORKFLOW]');
    // Iterate over pages of elements
    $pagedResponse = $executionsClient->listExecutions($formattedParent);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $executionsClient->listExecutions($formattedParent);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $executionsClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
`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.
`↳ view`	`int` Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view. For allowed values, use constants defined on Google\Cloud\Workflows\Executions\V1beta\ExecutionView
`↳ 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`

static::executionName

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

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

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

execution: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
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.executions.v1beta.Executions'

The name of the service.

SERVICE_ADDRESS

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