As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Workflows¶

class google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport, typing.Callable[[...], google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]¶

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

Instantiates the workflows async client.

Parameters

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 (Optional[Union[str,WorkflowsTransport,Callable[..., WorkflowsTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the WorkflowsTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.CreateWorkflowRequest, dict]] = None, *, parent: Optional[str] = None, workflow: Optional[google.cloud.workflows_v1beta.types.workflows.Workflow] = None, workflow_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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.

# 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 import workflows_v1beta

async def sample_create_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsAsyncClient()

    # Initialize request argument(s)
    workflow = workflows_v1beta.Workflow()
    workflow.source_contents = "source_contents_value"

    request = workflows_v1beta.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)

Parameters

request (Optional[Union[google.cloud.workflows_v1beta.types.CreateWorkflowRequest, dict]]) – The request object. Request for the [CreateWorkflow][google.cloud.workflows.v1beta.Workflows.CreateWorkflow] method.
parent (str) –
Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
workflow (google.cloud.workflows_v1beta.types.Workflow) – Required. Workflow to be created. This corresponds to the workflow field on the request instance; if request is provided, this should not be set.
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 workflow_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.workflows_v1beta.types.Workflow Workflow program to be executed by Workflows.

Return type

google.api_core.operation_async.AsyncOperation

async delete_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.DeleteWorkflowRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the 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 import workflows_v1beta

async def sample_delete_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsAsyncClient()

    # Initialize request argument(s)
    request = workflows_v1beta.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)

Parameters

request (Optional[Union[google.cloud.workflows_v1beta.types.DeleteWorkflowRequest, dict]]) – The request object. Request for the [DeleteWorkflow][google.cloud.workflows.v1beta.Workflows.DeleteWorkflow] method.
name (str) –
Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowsAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowsAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowsAsyncClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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 variable 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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async get_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.GetWorkflowRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.workflows_v1beta.types.workflows.Workflow[source]¶

Gets details of a single 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 import workflows_v1beta

async def sample_get_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsAsyncClient()

    # Initialize request argument(s)
    request = workflows_v1beta.GetWorkflowRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_workflow(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.workflows_v1beta.types.GetWorkflowRequest, dict]]) – The request object. Request for the [GetWorkflow][google.cloud.workflows.v1beta.Workflows.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 name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Workflow program to be executed by Workflows.

Return type

google.cloud.workflows_v1beta.types.Workflow

async list_workflows(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsAsyncPager[source]¶

Lists Workflows in a given project and location. The default order is not specified.

# 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 import workflows_v1beta

async def sample_list_workflows():
    # Create a client
    client = workflows_v1beta.WorkflowsAsyncClient()

    # Initialize request argument(s)
    request = workflows_v1beta.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)

Parameters

request (Optional[Union[google.cloud.workflows_v1beta.types.ListWorkflowsRequest, dict]]) – The request object. Request for the [ListWorkflows][google.cloud.workflows.v1beta.Workflows.ListWorkflows] method.
parent (str) –
Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response for the: [ListWorkflows][google.cloud.workflows.v1beta.Workflows.ListWorkflows] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_workflow_path(path: str) → Dict[str, str]¶: Parses a workflow path into its component segments.

property transport: google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: WorkflowsTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.UpdateWorkflowRequest, dict]] = None, *, workflow: Optional[google.cloud.workflows_v1beta.types.workflows.Workflow] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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.

# 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 import workflows_v1beta

async def sample_update_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsAsyncClient()

    # Initialize request argument(s)
    workflow = workflows_v1beta.Workflow()
    workflow.source_contents = "source_contents_value"

    request = workflows_v1beta.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)

Parameters

request (Optional[Union[google.cloud.workflows_v1beta.types.UpdateWorkflowRequest, dict]]) – The request object. Request for the [UpdateWorkflow][google.cloud.workflows.v1beta.Workflows.UpdateWorkflow] method.
workflow (google.cloud.workflows_v1beta.types.Workflow) – Required. Workflow to be updated. This corresponds to the workflow field on the request instance; if request is provided, this should not be set.
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 update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.workflows_v1beta.types.Workflow Workflow program to be executed by Workflows.

Return type

google.api_core.operation_async.AsyncOperation

static workflow_path(project: str, location: str, workflow: str) → str¶: Returns a fully-qualified workflow string.

class google.cloud.workflows_v1beta.services.workflows.WorkflowsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport, typing.Callable[[...], google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

Instantiates the workflows client.

Parameters

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 (Optional[Union[str,WorkflowsTransport,Callable[..., WorkflowsTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the WorkflowsTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.CreateWorkflowRequest, dict]] = None, *, parent: Optional[str] = None, workflow: Optional[google.cloud.workflows_v1beta.types.workflows.Workflow] = None, workflow_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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.

# 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 import workflows_v1beta

def sample_create_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsClient()

    # Initialize request argument(s)
    workflow = workflows_v1beta.Workflow()
    workflow.source_contents = "source_contents_value"

    request = workflows_v1beta.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.workflows_v1beta.types.CreateWorkflowRequest, dict]) – The request object. Request for the [CreateWorkflow][google.cloud.workflows.v1beta.Workflows.CreateWorkflow] method.
parent (str) –
Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
workflow (google.cloud.workflows_v1beta.types.Workflow) – Required. Workflow to be created. This corresponds to the workflow field on the request instance; if request is provided, this should not be set.
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 workflow_id field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.workflows_v1beta.types.Workflow Workflow program to be executed by Workflows.

Return type

google.api_core.operation.Operation

delete_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.DeleteWorkflowRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the 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 import workflows_v1beta

def sample_delete_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsClient()

    # Initialize request argument(s)
    request = workflows_v1beta.DeleteWorkflowRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_workflow(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.workflows_v1beta.types.DeleteWorkflowRequest, dict]) – The request object. Request for the [DeleteWorkflow][google.cloud.workflows.v1beta.Workflows.DeleteWorkflow] method.
name (str) –
Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

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);

}

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowsClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. 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 variable 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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.GetWorkflowRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.workflows_v1beta.types.workflows.Workflow[source]¶

Gets details of a single 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 import workflows_v1beta

def sample_get_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsClient()

    # Initialize request argument(s)
    request = workflows_v1beta.GetWorkflowRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_workflow(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.workflows_v1beta.types.GetWorkflowRequest, dict]) – The request object. Request for the [GetWorkflow][google.cloud.workflows.v1beta.Workflows.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 name field on the request instance; if request is provided, this should not be set.
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

Workflow program to be executed by Workflows.

Return type

google.cloud.workflows_v1beta.types.Workflow

list_workflows(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsPager[source]¶

Lists Workflows in a given project and location. The default order is not specified.

# 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 import workflows_v1beta

def sample_list_workflows():
    # Create a client
    client = workflows_v1beta.WorkflowsClient()

    # Initialize request argument(s)
    request = workflows_v1beta.ListWorkflowsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_workflows(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.workflows_v1beta.types.ListWorkflowsRequest, dict]) – The request object. Request for the [ListWorkflows][google.cloud.workflows.v1beta.Workflows.ListWorkflows] method.
parent (str) –
Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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

Response for the: [ListWorkflows][google.cloud.workflows.v1beta.Workflows.ListWorkflows] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_workflow_path(path: str) → Dict[str, str][source]¶: Parses a workflow path into its component segments.

property transport: google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

WorkflowsTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_workflow(request: Optional[Union[google.cloud.workflows_v1beta.types.workflows.UpdateWorkflowRequest, dict]] = None, *, workflow: Optional[google.cloud.workflows_v1beta.types.workflows.Workflow] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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.

# 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 import workflows_v1beta

def sample_update_workflow():
    # Create a client
    client = workflows_v1beta.WorkflowsClient()

    # Initialize request argument(s)
    workflow = workflows_v1beta.Workflow()
    workflow.source_contents = "source_contents_value"

    request = workflows_v1beta.UpdateWorkflowRequest(
        workflow=workflow,
    )

    # Make the request
    operation = client.update_workflow(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.workflows_v1beta.types.UpdateWorkflowRequest, dict]) – The request object. Request for the [UpdateWorkflow][google.cloud.workflows.v1beta.Workflows.UpdateWorkflow] method.
workflow (google.cloud.workflows_v1beta.types.Workflow) – Required. Workflow to be updated. This corresponds to the workflow field on the request instance; if request is provided, this should not be set.
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 update_mask field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.workflows_v1beta.types.Workflow Workflow program to be executed by Workflows.

Return type

google.api_core.operation.Operation

static workflow_path(project: str, location: str, workflow: str) → str[source]¶: Returns a fully-qualified workflow string.

class google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsAsyncPager(method: Callable[[...], Awaitable[google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse]], request: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest, response: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_workflows requests.

This class thinly wraps an initial google.cloud.workflows_v1beta.types.ListWorkflowsResponse object, and provides an __aiter__ method to iterate through its workflows field.

If there are more pages, the __aiter__ method will make additional ListWorkflows requests and continue to iterate through the workflows field on the corresponding responses.

All the usual google.cloud.workflows_v1beta.types.ListWorkflowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.workflows_v1beta.types.ListWorkflowsRequest) – The initial request object.
response (google.cloud.workflows_v1beta.types.ListWorkflowsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsPager(method: Callable[[...], google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse], request: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest, response: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_workflows requests.

This class thinly wraps an initial google.cloud.workflows_v1beta.types.ListWorkflowsResponse object, and provides an __iter__ method to iterate through its workflows field.

If there are more pages, the __iter__ method will make additional ListWorkflows requests and continue to iterate through the workflows field on the corresponding responses.

All the usual google.cloud.workflows_v1beta.types.ListWorkflowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.workflows_v1beta.types.ListWorkflowsRequest) – The initial request object.
response (google.cloud.workflows_v1beta.types.ListWorkflowsResponse) – The initial response object.
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.

Workflows¶

google-cloud-workflows

Navigation

Related Topics