Reference documentation and code samples for the Google Cloud Workflows V1 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.
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 \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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.
The async variant is Google\Cloud\Workflows\Executions\V1\Client\ExecutionsClient::cancelExecutionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\CancelExecutionRequest
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\Workflows\Executions\V1\Execution |
createExecution
Creates a new execution using the latest revision of the given workflow.
The async variant is Google\Cloud\Workflows\Executions\V1\Client\ExecutionsClient::createExecutionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\CreateExecutionRequest
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\Workflows\Executions\V1\Execution |
getExecution
Returns an execution of the given name.
The async variant is Google\Cloud\Workflows\Executions\V1\Client\ExecutionsClient::getExecutionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\GetExecutionRequest
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\Workflows\Executions\V1\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).
The async variant is Google\Cloud\Workflows\Executions\V1\Client\ExecutionsClient::listExecutionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\ListExecutionsRequest
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 |
cancelExecutionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\CancelExecutionRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createExecutionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\CreateExecutionRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getExecutionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\GetExecutionRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listExecutionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Workflows\Executions\V1\ListExecutionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
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. |