WorkflowsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport] = '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>)Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.
Inheritance
builtins.object > WorkflowsAsyncClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| WorkflowsTransport | The transport used by the client instance. |
Methods
WorkflowsAsyncClient
WorkflowsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport] = '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 workflows 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, `.WorkflowsTransport`]
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. |
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_workflow
create_workflow(request: Optional[Union[google.cloud.workflows_v1.types.workflows.CreateWorkflowRequest, dict]] = None, *, parent: Optional[str] = None, workflow: Optional[google.cloud.workflows_v1.types.workflows.Workflow] = None, workflow_id: 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]] = ())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.
from google.cloud import workflows_v1
async def sample_create_workflow():
# Create a client
client = workflows_v1.WorkflowsAsyncClient()
# Initialize request argument(s)
workflow = workflows_v1.Workflow()
workflow.source_contents = "source_contents_value"
request = workflows_v1.CreateWorkflowRequest(
parent="parent_value",
workflow=workflow,
workflow_id="workflow_id_value",
)
# Make the request
operation = client.create_workflow(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.workflows_v1.types.CreateWorkflowRequest, dict]
The request object. Request for the CreateWorkflow method. |
| parent |
`str`
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 |
`str`
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. |
| 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[Union[google.cloud.workflows_v1.types.workflows.DeleteWorkflowRequest, 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]] = ())Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
from google.cloud import workflows_v1
async def sample_delete_workflow():
# Create a client
client = workflows_v1.WorkflowsAsyncClient()
# Initialize request argument(s)
request = workflows_v1.DeleteWorkflowRequest(
name="name_value",
)
# Make the request
operation = client.delete_workflow(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.workflows_v1.types.DeleteWorkflowRequest, dict]
The request object. Request for the DeleteWorkflow method. |
| name |
`str`
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. |
| 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.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| 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.
| Name | Description |
| info |
dict
The service account private key info. |
| 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.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| WorkflowsAsyncClient | The constructed client. |
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.
get_workflow
get_workflow(request: Optional[Union[google.cloud.workflows_v1.types.workflows.GetWorkflowRequest, 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]] = ())Gets details of a single Workflow.
from google.cloud import workflows_v1
async def sample_get_workflow():
# Create a client
client = workflows_v1.WorkflowsAsyncClient()
# Initialize request argument(s)
request = workflows_v1.GetWorkflowRequest(
name="name_value",
)
# Make the request
response = await client.get_workflow(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.workflows_v1.types.GetWorkflowRequest, dict]
The request object. Request for the GetWorkflow method. |
| name |
`str`
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. |
| Type | Description |
| google.cloud.workflows_v1.types.Workflow | Workflow program to be executed by Workflows. |
list_workflows
list_workflows(request: Optional[Union[google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest, 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]] = ())Lists Workflows in a given project and location. The default order is not specified.
from google.cloud import workflows_v1
async def sample_list_workflows():
# Create a client
client = workflows_v1.WorkflowsAsyncClient()
# Initialize request argument(s)
request = workflows_v1.ListWorkflowsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_workflows(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.workflows_v1.types.ListWorkflowsRequest, dict]
The request object. Request for the ListWorkflows method. |
| parent |
`str`
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. |
| 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)Parses a workflow path into its component segments.
update_workflow
update_workflow(request: Optional[Union[google.cloud.workflows_v1.types.workflows.UpdateWorkflowRequest, dict]] = None, *, workflow: Optional[google.cloud.workflows_v1.types.workflows.Workflow] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())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.
from google.cloud import workflows_v1
async def sample_update_workflow():
# Create a client
client = workflows_v1.WorkflowsAsyncClient()
# Initialize request argument(s)
workflow = workflows_v1.Workflow()
workflow.source_contents = "source_contents_value"
request = workflows_v1.UpdateWorkflowRequest(
workflow=workflow,
)
# Make the request
operation = client.update_workflow(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.workflows_v1.types.UpdateWorkflowRequest, dict]
The request object. Request for the UpdateWorkflow method. |
| workflow |
Workflow
Required. Workflow to be updated. This corresponds to the |
| update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
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. |
| 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)Returns a fully-qualified workflow string.