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.

Types for Google Cloud Workflows v1 API

class google.cloud.workflows_v1.types.CreateWorkflowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the [CreateWorkflow][google.cloud.workflows.v1.Workflows.CreateWorkflow] method.

parent

Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}

Type

str

workflow

Required. Workflow to be created.

Type

google.cloud.workflows_v1.types.Workflow

workflow_id

Required. The ID of the workflow to be created. It has to fulfill the following requirements:

  • Must contain only letters, numbers, underscores and hyphens.

  • Must start with a letter.

  • Must be between 1-64 characters.

  • Must end with a number or a letter.

  • Must be unique within the customer project and location.

Type

str

class google.cloud.workflows_v1.types.DeleteWorkflowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the [DeleteWorkflow][google.cloud.workflows.v1.Workflows.DeleteWorkflow] method.

name

Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}

Type

str

class google.cloud.workflows_v1.types.GetWorkflowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the [GetWorkflow][google.cloud.workflows.v1.Workflows.GetWorkflow] method.

name

Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}

Type

str

class google.cloud.workflows_v1.types.ListWorkflowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows] method.

parent

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

Type

str

page_size

Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.

Type

int

page_token

A page token, received from a previous ListWorkflows call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflows must match the call that provided the page token.

Type

str

filter

Filter to restrict results to specific workflows.

Type

str

order_by

Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a ” desc” suffix. If not specified, the results will be returned in an unspecified order.

Type

str

class google.cloud.workflows_v1.types.ListWorkflowsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

workflows

The workflows which match the request.

Type

Sequence[google.cloud.workflows_v1.types.Workflow]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

unreachable

Unreachable resources.

Type

Sequence[str]

property raw_page
class google.cloud.workflows_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the metadata of the long-running operation.

create_time

The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

The time the operation finished running.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Server-defined resource path for the target of the operation.

Type

str

verb

Name of the verb executed by the operation.

Type

str

api_version

API version used to start the operation.

Type

str

class google.cloud.workflows_v1.types.UpdateWorkflowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the [UpdateWorkflow][google.cloud.workflows.v1.Workflows.UpdateWorkflow] method.

workflow

Required. Workflow to be updated.

Type

google.cloud.workflows_v1.types.Workflow

update_mask

List of fields to be updated. If not present, the entire workflow will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.workflows_v1.types.Workflow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Workflow program to be executed by Workflows.

name

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}

Type

str

description

Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

Type

str

state

Output only. State of the workflow deployment.

Type

google.cloud.workflows_v1.types.Workflow.State

revision_id

Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following fields of a workflow:

  • source_code

  • service_account The format is “000001-a4d”, where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.

Type

str

create_time

Output only. The timestamp of when the workflow was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The last update timestamp of the workflow.

Type

google.protobuf.timestamp_pb2.Timestamp

revision_create_time

Output only. The timestamp that the latest revision of the workflow was created.

Type

google.protobuf.timestamp_pb2.Timestamp

labels

Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.

Type

Sequence[google.cloud.workflows_v1.types.Workflow.LabelsEntry]

service_account

Name of the service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account}

Using - as a wildcard for the {project} will infer the project from the account. The {account} value can be the email address or the unique_id of the service account.

If not provided, workflow will use the project’s default service account. Modifying this field for an existing workflow results in a new workflow revision.

Type

str

source_contents

Workflow code to be executed. The size limit is 32KB.

Type

str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)[source]

Bases: proto.enums.Enum

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

ACTIVE = 1
STATE_UNSPECIFIED = 0