WorkflowsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-workflows/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.
Properties
transport
Return the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
WorkflowsTransport | The transport used by the client instance. |
Methods
WorkflowsAsyncClient
WorkflowsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-workflows/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiate the workflows client.
| Parameters | |
|---|---|
| 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,
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 |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)Return a fully-qualified project string.
create_workflow
create_workflow(request: Optional[google.cloud.workflows_v1.types.workflows.CreateWorkflowRequest] = None, *, parent: Optional[str] = None, workflow: Optional[google.cloud.workflows_v1.types.workflows.Workflow] = None, workflow_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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][google.rpc.Code.ALREADY_EXISTS] error.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateWorkflowRequest
The request object. Request for the CreateWorkflow method. |
parent |
Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location} This corresponds to the |
workflow |
Workflow
Required. Workflow to be created. This corresponds to the |
workflow_id |
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. 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. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Workflow Workflow program to be executed by Workflows. |
delete_workflow
delete_workflow(request: Optional[google.cloud.workflows_v1.types.workflows.DeleteWorkflowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteWorkflowRequest
The request object. Request for the DeleteWorkflow method. |
name |
Required. Name of the workflow to be deleted. 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. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
WorkflowsAsyncClient | 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.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
WorkflowsAsyncClient | 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.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
WorkflowsAsyncClient | The constructed client. |
get_transport_class
get_transport_class()Return an appropriate transport class.
get_workflow
get_workflow(request: Optional[google.cloud.workflows_v1.types.workflows.GetWorkflowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets details of a single Workflow.
| Parameters | |
|---|---|
| Name | Description |
request |
GetWorkflowRequest
The request object. Request for the GetWorkflow method. |
name |
Required. Name of the workflow which information should be retrieved. 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. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.workflows_v1.types.Workflow | Workflow program to be executed by Workflows. |
list_workflows
list_workflows(request: Optional[google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists Workflows in a given project and location. The default order is not specified.
| Parameters | |
|---|---|
| Name | Description |
request |
ListWorkflowsRequest
The request object. Request for the ListWorkflows method. |
parent |
Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location} 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. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsAsyncPager | Response for the ListWorkflows 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_workflow_path
parse_workflow_path(path: str)Parse a workflow path into its component segments.
update_workflow
update_workflow(request: Optional[google.cloud.workflows_v1.types.workflows.UpdateWorkflowRequest] = None, *, workflow: Optional[google.cloud.workflows_v1.types.workflows.Workflow] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 |
request |
UpdateWorkflowRequest
The request object. Request for the UpdateWorkflow method. |
workflow |
Workflow
Required. Workflow to be updated. This corresponds to the |
update_mask |
List of fields to be updated. If not present, the entire workflow will be updated. 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. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Workflow Workflow program to be executed by Workflows. |
workflow_path
workflow_path(project: str, location: str, workflow: str)Return a fully-qualified workflow string.