Package Classes (1.19.0)

Summary of entries of Classes for workflows.

Classes

ExecutionsAsyncClient

Executions is used to start and manage running instances ofWorkflows called executions.

ExecutionsClient

Executions is used to start and manage running instances ofWorkflows called executions.

ListExecutionsAsyncPager

A pager for iterating throughlist_executions requests.

This class thinly wraps an initialListExecutionsResponse object, andprovides an__aiter__ method to iterate through itsexecutions field.

If there are more pages, the__aiter__ method will make additionalListExecutions requests and continue to iteratethrough theexecutions field on thecorresponding responses.

All the usualListExecutionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListExecutionsPager

A pager for iterating throughlist_executions requests.

This class thinly wraps an initialListExecutionsResponse object, andprovides an__iter__ method to iterate through itsexecutions field.

If there are more pages, the__iter__ method will make additionalListExecutions requests and continue to iteratethrough theexecutions field on thecorresponding responses.

All the usualListExecutionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

CancelExecutionRequest

Request for theCancelExecutionmethod.

CreateExecutionRequest

Request for theCreateExecutionmethod.

Execution

A running instance of aWorkflow </workflows/docs/reference/rest/v1/projects.locations.workflows>__.

CallLogLevel

Describes the level of platform logging to apply to calls andcall responses during workflow executions.

Error

Error describes why the execution was abnormally terminated.

LabelsEntry

The abstract base class for a message.

StackTrace

A collection of stack elements (frames) where an erroroccurred.

StackTraceElement

A single stack element (frame) where an error occurred.

Position

Position contains source position information about the stacktrace element such as line number, column number and length ofthe code block in bytes.

State

Describes the current state of the execution. More statesmight be added in the future.

StateError

Describes an error related to the current state of theExecution resource.

Type

Describes the possible types of a state error.

Status

Represents the current status of this execution.

Step

Represents a step of the workflow this execution is running.

ExecutionView

Defines possible views for execution resource.

GetExecutionRequest

Request for theGetExecutionmethod.

ListExecutionsRequest

Request for the [ListExecutions][] method.

ListExecutionsResponse

Response for theListExecutionsmethod.

ExecutionsAsyncClient

Executions is used to start and manage running instances ofWorkflows calledexecutions.

ExecutionsClient

Executions is used to start and manage running instances ofWorkflows calledexecutions.

ListExecutionsAsyncPager

A pager for iterating throughlist_executions requests.

This class thinly wraps an initialListExecutionsResponse object, andprovides an__aiter__ method to iterate through itsexecutions field.

If there are more pages, the__aiter__ method will make additionalListExecutions requests and continue to iteratethrough theexecutions field on thecorresponding responses.

All the usualListExecutionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListExecutionsPager

A pager for iterating throughlist_executions requests.

This class thinly wraps an initialListExecutionsResponse object, andprovides an__iter__ method to iterate through itsexecutions field.

If there are more pages, the__iter__ method will make additionalListExecutions requests and continue to iteratethrough theexecutions field on thecorresponding responses.

All the usualListExecutionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

CancelExecutionRequest

Request for theCancelExecutionmethod.

CreateExecutionRequest

Request for theCreateExecutionmethod.

Execution

A running instance of aWorkflow.

Error

Error describes why the execution was abnormally terminated.

State

Describes the current state of the execution. More states maybe added in the future.

ExecutionView

Defines possible views for execution resource.

GetExecutionRequest

Request for theGetExecutionmethod.

ListExecutionsRequest

Request for theListExecutionsmethod.

ListExecutionsResponse

Response for theListExecutionsmethod.

WorkflowsAsyncClient

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

WorkflowsClient

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

ListWorkflowRevisionsAsyncPager

A pager for iterating throughlist_workflow_revisions requests.

This class thinly wraps an initialListWorkflowRevisionsResponse object, andprovides an__aiter__ method to iterate through itsworkflows field.

If there are more pages, the__aiter__ method will make additionalListWorkflowRevisions requests and continue to iteratethrough theworkflows field on thecorresponding responses.

All the usualListWorkflowRevisionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListWorkflowRevisionsPager

A pager for iterating throughlist_workflow_revisions requests.

This class thinly wraps an initialListWorkflowRevisionsResponse object, andprovides an__iter__ method to iterate through itsworkflows field.

If there are more pages, the__iter__ method will make additionalListWorkflowRevisions requests and continue to iteratethrough theworkflows field on thecorresponding responses.

All the usualListWorkflowRevisionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListWorkflowsAsyncPager

A pager for iterating throughlist_workflows requests.

This class thinly wraps an initialListWorkflowsResponse object, andprovides an__aiter__ method to iterate through itsworkflows field.

If there are more pages, the__aiter__ method will make additionalListWorkflows requests and continue to iteratethrough theworkflows field on thecorresponding responses.

All the usualListWorkflowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListWorkflowsPager

A pager for iterating throughlist_workflows requests.

This class thinly wraps an initialListWorkflowsResponse object, andprovides an__iter__ method to iterate through itsworkflows field.

If there are more pages, the__iter__ method will make additionalListWorkflows requests and continue to iteratethrough theworkflows field on thecorresponding responses.

All the usualListWorkflowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

CreateWorkflowRequest

Request for theCreateWorkflowmethod.

DeleteWorkflowRequest

Request for theDeleteWorkflowmethod.

ExecutionHistoryLevel

Define possible options for enabling the execution historylevel.

GetWorkflowRequest

Request for theGetWorkflowmethod.

ListWorkflowRevisionsRequest

Request for theListWorkflowRevisionsmethod.

ListWorkflowRevisionsResponse

Response for theListWorkflowRevisionsmethod.

ListWorkflowsRequest

Request for theListWorkflowsmethod.

ListWorkflowsResponse

Response for theListWorkflowsmethod.

OperationMetadata

Represents the metadata of the long-running operation.

UpdateWorkflowRequest

Request for theUpdateWorkflowmethod.

Workflow

Workflow program to be executed by Workflows.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CallLogLevel

Describes the level of platform logging to apply to calls andcall responses during workflow executions.

LabelsEntry

The abstract base class for a message.

State

Describes the current state of workflow deployment.

StateError

Describes an error related to the current state of theworkflow.

Type

Describes the possibled types of a state error.

TagsEntry

The abstract base class for a message.

UserEnvVarsEntry

The abstract base class for a message.

WorkflowsAsyncClient

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

WorkflowsClient

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

ListWorkflowsAsyncPager

A pager for iterating throughlist_workflows requests.

This class thinly wraps an initialListWorkflowsResponse object, andprovides an__aiter__ method to iterate through itsworkflows field.

If there are more pages, the__aiter__ method will make additionalListWorkflows requests and continue to iteratethrough theworkflows field on thecorresponding responses.

All the usualListWorkflowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListWorkflowsPager

A pager for iterating throughlist_workflows requests.

This class thinly wraps an initialListWorkflowsResponse object, andprovides an__iter__ method to iterate through itsworkflows field.

If there are more pages, the__iter__ method will make additionalListWorkflows requests and continue to iteratethrough theworkflows field on thecorresponding responses.

All the usualListWorkflowsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

CreateWorkflowRequest

Request for theCreateWorkflowmethod.

DeleteWorkflowRequest

Request for theDeleteWorkflowmethod.

GetWorkflowRequest

Request for theGetWorkflowmethod.

ListWorkflowsRequest

Request for theListWorkflowsmethod.

ListWorkflowsResponse

Response for theListWorkflowsmethod.

OperationMetadata

Represents the metadata of the long-running operation.

UpdateWorkflowRequest

Request for theUpdateWorkflowmethod.

Workflow

Workflow program to be executed by Workflows.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

State

Describes the current state of workflow deployment. Morestates may be added in the future.

Modules

pagers

API documentation forworkflows.executions_v1.services.executions.pagers module.

pagers

API documentation forworkflows.executions_v1beta.services.executions.pagers module.

pagers

API documentation forworkflows_v1.services.workflows.pagers module.

pagers

API documentation forworkflows_v1beta.services.workflows.pagers module.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.