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.

Source code for google.cloud.workflows_v1.types.workflows

# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import proto  # type: ignore

from google.protobuf import field_mask_pb2  # type: ignore
from google.protobuf import timestamp_pb2  # type: ignore


__protobuf__ = proto.module(
    package="google.cloud.workflows.v1",
    manifest={
        "Workflow",
        "ListWorkflowsRequest",
        "ListWorkflowsResponse",
        "GetWorkflowRequest",
        "CreateWorkflowRequest",
        "DeleteWorkflowRequest",
        "UpdateWorkflowRequest",
        "OperationMetadata",
    },
)


[docs]class Workflow(proto.Message): r"""Workflow program to be executed by Workflows. Attributes: name (str): The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow} description (str): Description of the workflow provided by the user. Must be at most 1000 unicode characters long. state (google.cloud.workflows_v1.types.Workflow.State): Output only. State of the workflow deployment. revision_id (str): 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. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The timestamp of when the workflow was created. update_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The last update timestamp of the workflow. revision_create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The timestamp that the latest revision of the workflow was created. labels (Sequence[google.cloud.workflows_v1.types.Workflow.LabelsEntry]): 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. service_account (str): 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. source_contents (str): Workflow code to be executed. The size limit is 32KB. """
[docs] class State(proto.Enum): r"""Describes the current state of workflow deployment. More states may be added in the future. """ STATE_UNSPECIFIED = 0 ACTIVE = 1
name = proto.Field(proto.STRING, number=1,) description = proto.Field(proto.STRING, number=2,) state = proto.Field(proto.ENUM, number=3, enum=State,) revision_id = proto.Field(proto.STRING, number=4,) create_time = proto.Field(proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp,) update_time = proto.Field(proto.MESSAGE, number=6, message=timestamp_pb2.Timestamp,) revision_create_time = proto.Field( proto.MESSAGE, number=7, message=timestamp_pb2.Timestamp, ) labels = proto.MapField(proto.STRING, proto.STRING, number=8,) service_account = proto.Field(proto.STRING, number=9,) source_contents = proto.Field(proto.STRING, number=10, oneof="source_code",)
[docs]class ListWorkflowsRequest(proto.Message): r"""Request for the [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows] method. Attributes: parent (str): Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location} page_size (int): 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. page_token (str): 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. filter (str): Filter to restrict results to specific workflows. order_by (str): 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. """ parent = proto.Field(proto.STRING, number=1,) page_size = proto.Field(proto.INT32, number=2,) page_token = proto.Field(proto.STRING, number=3,) filter = proto.Field(proto.STRING, number=4,) order_by = proto.Field(proto.STRING, number=5,)
[docs]class ListWorkflowsResponse(proto.Message): r"""Response for the [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows] method. Attributes: workflows (Sequence[google.cloud.workflows_v1.types.Workflow]): The workflows which match the request. next_page_token (str): A token, which can be sent as ``page_token`` to retrieve the next page. If this field is omitted, there are no subsequent pages. unreachable (Sequence[str]): Unreachable resources. """ @property def raw_page(self): return self workflows = proto.RepeatedField(proto.MESSAGE, number=1, message="Workflow",) next_page_token = proto.Field(proto.STRING, number=2,) unreachable = proto.RepeatedField(proto.STRING, number=3,)
[docs]class GetWorkflowRequest(proto.Message): r"""Request for the [GetWorkflow][google.cloud.workflows.v1.Workflows.GetWorkflow] method. Attributes: name (str): Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow} """ name = proto.Field(proto.STRING, number=1,)
[docs]class CreateWorkflowRequest(proto.Message): r"""Request for the [CreateWorkflow][google.cloud.workflows.v1.Workflows.CreateWorkflow] method. Attributes: parent (str): Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location} workflow (google.cloud.workflows_v1.types.Workflow): Required. Workflow to be created. 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. """ parent = proto.Field(proto.STRING, number=1,) workflow = proto.Field(proto.MESSAGE, number=2, message="Workflow",) workflow_id = proto.Field(proto.STRING, number=3,)
[docs]class DeleteWorkflowRequest(proto.Message): r"""Request for the [DeleteWorkflow][google.cloud.workflows.v1.Workflows.DeleteWorkflow] method. Attributes: name (str): Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow} """ name = proto.Field(proto.STRING, number=1,)
[docs]class UpdateWorkflowRequest(proto.Message): r"""Request for the [UpdateWorkflow][google.cloud.workflows.v1.Workflows.UpdateWorkflow] method. Attributes: workflow (google.cloud.workflows_v1.types.Workflow): Required. Workflow to be updated. update_mask (google.protobuf.field_mask_pb2.FieldMask): List of fields to be updated. If not present, the entire workflow will be updated. """ workflow = proto.Field(proto.MESSAGE, number=1, message="Workflow",) update_mask = proto.Field( proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask, )
[docs]class OperationMetadata(proto.Message): r"""Represents the metadata of the long-running operation. Attributes: create_time (google.protobuf.timestamp_pb2.Timestamp): The time the operation was created. end_time (google.protobuf.timestamp_pb2.Timestamp): The time the operation finished running. target (str): Server-defined resource path for the target of the operation. verb (str): Name of the verb executed by the operation. api_version (str): API version used to start the operation. """ create_time = proto.Field(proto.MESSAGE, number=1, message=timestamp_pb2.Timestamp,) end_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,) target = proto.Field(proto.STRING, number=3,) verb = proto.Field(proto.STRING, number=4,) api_version = proto.Field(proto.STRING, number=5,)
__all__ = tuple(sorted(__protobuf__.manifest))