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_v1.services.workflows.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/.nox/docs/lib/python3.8/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>)[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 (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 transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

Raises

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

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[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 = <object object>, timeout: Optional[float] = None, 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.

Parameters
  • request (google.cloud.workflows_v1.types.CreateWorkflowRequest) – The request object. Request for the [CreateWorkflow][google.cloud.workflows.v1.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_v1.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_v1.types.Workflow Workflow program to be executed by Workflows.

Return type

google.api_core.operation_async.AsyncOperation

async delete_workflow(request: Optional[google.cloud.workflows_v1.types.workflows.DeleteWorkflowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters
  • request (google.cloud.workflows_v1.types.DeleteWorkflowRequest) – The request object. Request for the [DeleteWorkflow][google.cloud.workflows.v1.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);

}

The JSON representation for Empty is empty JSON object {}.

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

get_transport_class()Type[google.cloud.workflows_v1.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[google.cloud.workflows_v1.types.workflows.GetWorkflowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.workflows_v1.types.workflows.Workflow[source]

Gets details of a single Workflow.

Parameters
  • request (google.cloud.workflows_v1.types.GetWorkflowRequest) – The request object. Request for the [GetWorkflow][google.cloud.workflows.v1.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_v1.types.Workflow

async list_workflows(request: Optional[google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsAsyncPager[source]

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

Parameters
  • request (google.cloud.workflows_v1.types.ListWorkflowsRequest) – The request object. Request for the [ListWorkflows][google.cloud.workflows.v1.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.v1.Workflows.ListWorkflows] method.

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

Return type

google.cloud.workflows_v1.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_v1.services.workflows.transports.base.WorkflowsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

WorkflowsTransport

async 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 = <object object>, timeout: Optional[float] = None, 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.

Parameters
  • request (google.cloud.workflows_v1.types.UpdateWorkflowRequest) – The request object. Request for the [UpdateWorkflow][google.cloud.workflows.v1.Workflows.UpdateWorkflow] method.

  • workflow (google.cloud.workflows_v1.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_v1.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_v1.services.workflows.WorkflowsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport]] = None, 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>)[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 (Union[str, WorkflowsTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

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

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[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 = <object object>, timeout: Optional[float] = None, 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.

Parameters
  • request (google.cloud.workflows_v1.types.CreateWorkflowRequest) – The request object. Request for the [CreateWorkflow][google.cloud.workflows.v1.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_v1.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_v1.types.Workflow Workflow program to be executed by Workflows.

Return type

google.api_core.operation.Operation

delete_workflow(request: Optional[google.cloud.workflows_v1.types.workflows.DeleteWorkflowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters
  • request (google.cloud.workflows_v1.types.DeleteWorkflowRequest) – The request object. Request for the [DeleteWorkflow][google.cloud.workflows.v1.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);

}

The JSON representation for Empty is empty JSON object {}.

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

get_workflow(request: Optional[google.cloud.workflows_v1.types.workflows.GetWorkflowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.workflows_v1.types.workflows.Workflow[source]

Gets details of a single Workflow.

Parameters
  • request (google.cloud.workflows_v1.types.GetWorkflowRequest) – The request object. Request for the [GetWorkflow][google.cloud.workflows.v1.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_v1.types.Workflow

list_workflows(request: Optional[google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsPager[source]

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

Parameters
  • request (google.cloud.workflows_v1.types.ListWorkflowsRequest) – The request object. Request for the [ListWorkflows][google.cloud.workflows.v1.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.v1.Workflows.ListWorkflows] method.

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

Return type

google.cloud.workflows_v1.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_v1.services.workflows.transports.base.WorkflowsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

WorkflowsTransport

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 = <object object>, timeout: Optional[float] = None, 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.

Parameters
  • request (google.cloud.workflows_v1.types.UpdateWorkflowRequest) – The request object. Request for the [UpdateWorkflow][google.cloud.workflows.v1.Workflows.UpdateWorkflow] method.

  • workflow (google.cloud.workflows_v1.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_v1.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_v1.services.workflows.pagers.ListWorkflowsAsyncPager(method: Callable[[...], Awaitable[google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse]], request: google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest, response: google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_workflows requests.

This class thinly wraps an initial google.cloud.workflows_v1.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_v1.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
class google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsPager(method: Callable[[...], google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse], request: google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest, response: google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_workflows requests.

This class thinly wraps an initial google.cloud.workflows_v1.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_v1.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