ExecutionsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.workflows.executions_v1beta.services.executions.transports.base.ExecutionsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Executions is used to start and manage running instances of Workflows called executions.
Inheritance
builtins.object > ExecutionsAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
ExecutionsTransport | The transport used by the client instance. |
Methods
ExecutionsAsyncClient
ExecutionsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.workflows.executions_v1beta.services.executions.transports.base.ExecutionsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the executions client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, `.ExecutionsTransport`]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
cancel_execution
cancel_execution(request: Optional[Union[google.cloud.workflows.executions_v1beta.types.executions.CancelExecutionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Cancels an execution of the given name.
# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.workflows import executions_v1beta
async def sample_cancel_execution():
# Create a client
client = executions_v1beta.ExecutionsAsyncClient()
# Initialize request argument(s)
request = executions_v1beta.CancelExecutionRequest(
name="name_value",
)
# Make the request
response = await client.cancel_execution(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.workflows.executions_v1beta.types.CancelExecutionRequest, dict]
The request object. Request for the CancelExecution method. |
name |
`str`
Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.workflows.executions_v1beta.types.Execution | A running instance of a Workflow. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_execution
create_execution(request: Optional[Union[google.cloud.workflows.executions_v1beta.types.executions.CreateExecutionRequest, dict]] = None, *, parent: Optional[str] = None, execution: Optional[google.cloud.workflows.executions_v1beta.types.executions.Execution] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new execution using the latest revision of the given workflow.
# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.workflows import executions_v1beta
async def sample_create_execution():
# Create a client
client = executions_v1beta.ExecutionsAsyncClient()
# Initialize request argument(s)
request = executions_v1beta.CreateExecutionRequest(
parent="parent_value",
)
# Make the request
response = await client.create_execution(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.workflows.executions_v1beta.types.CreateExecutionRequest, dict]
The request object. Request for the CreateExecution method. |
parent |
`str`
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. This corresponds to the |
execution |
Execution
Required. Execution to be created. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.workflows.executions_v1beta.types.Execution | A running instance of a Workflow. |
execution_path
execution_path(project: str, location: str, workflow: str, execution: str)
Returns a fully-qualified execution string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ExecutionsAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
ExecutionsAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ExecutionsAsyncClient | The constructed client. |
get_execution
get_execution(request: Optional[Union[google.cloud.workflows.executions_v1beta.types.executions.GetExecutionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns an execution of the given name.
# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.workflows import executions_v1beta
async def sample_get_execution():
# Create a client
client = executions_v1beta.ExecutionsAsyncClient()
# Initialize request argument(s)
request = executions_v1beta.GetExecutionRequest(
name="name_value",
)
# Make the request
response = await client.get_execution(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.workflows.executions_v1beta.types.GetExecutionRequest, dict]
The request object. Request for the GetExecution method. |
name |
`str`
Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.workflows.executions_v1beta.types.Execution | A running instance of a Workflow. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_executions
list_executions(request: Optional[Union[google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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).
# This snippet 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 as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.workflows import executions_v1beta
async def sample_list_executions():
# Create a client
client = executions_v1beta.ExecutionsAsyncClient()
# Initialize request argument(s)
request = executions_v1beta.ListExecutionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_executions(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.workflows.executions_v1beta.types.ListExecutionsRequest, dict]
The request object. Request for the ListExecutions method. |
parent |
`str`
Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.workflows.executions_v1beta.services.executions.pagers.ListExecutionsAsyncPager | Response for the ListExecutions method. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_execution_path
parse_execution_path(path: str)
Parses a execution path into its component segments.
parse_workflow_path
parse_workflow_path(path: str)
Parses a workflow path into its component segments.
workflow_path
workflow_path(project: str, location: str, workflow: str)
Returns a fully-qualified workflow string.