Skip to content
This repository has been archived by the owner on Jul 6, 2023. It is now read-only.

Commit

Permalink
chore: update docstring for 'Workflow' message (from proto) (#108)
Browse files Browse the repository at this point in the history
* docs: clarified when revision_id of a workflow is updated docs: clarified format and semantics of service_account field docs: documented expanded workflow size limit

PiperOrigin-RevId: 404237609

Source-Link: googleapis/googleapis@2d60c59

Source-Link: https://github.com/googleapis/googleapis-gen/commit/ec5a08b7e6d0e3c774516e4169893a5886856423
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWM1YTA4YjdlNmQwZTNjNzc0NTE2ZTQxNjk4OTNhNTg4Njg1NjQyMyJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Oct 19, 2021
1 parent 7eac117 commit c238e30
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions google/cloud/workflows_v1/types/workflows.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,16 @@ class Workflow(proto.Message):
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:
properties 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.
- [Service
account][google.cloud.workflows.v1.Workflow.service_account]
- [Workflow code to be
executed][google.cloud.workflows.v1.Workflow.source_contents]
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.
Expand All @@ -77,23 +80,23 @@ class Workflow(proto.Message):
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}
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} or
{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.
Using ``-`` as a wildcard for the ``{project}`` or not
providing one at all 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.
is 128KB.
"""

class State(proto.Enum):
Expand Down

0 comments on commit c238e30

Please sign in to comment.