Reference documentation and code samples for the Workflows V1 API class Google::Cloud::Workflows::V1::Workflow.
Workflow program to be executed by Workflows.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The timestamp of when the workflow was created.
#description
def description() -> ::String
- (::String) — Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
#description=
def description=(value) -> ::String
- value (::String) — Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
- (::String) — Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — 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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — 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.
- (::Google::Protobuf::Map{::String => ::String}) — 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.
#name
def name() -> ::String
- (::String) — The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
#name=
def name=(value) -> ::String
- value (::String) — The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
- (::String) — The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
#revision_create_time
def revision_create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The timestamp that the latest revision of the workflow was created.
#revision_id
def revision_id() -> ::String
-
(::String) — Output only. The revision of the workflow.
A new revision of a workflow is created as a result of updating the
following properties of a workflow:
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
def service_account() -> ::String
-
(::String) — 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}
or not providing one at all will infer the project from the account. The{account}
value can be theemail
address or theunique_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.
#service_account=
def service_account=(value) -> ::String
-
value (::String) — 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}
or not providing one at all will infer the project from the account. The{account}
value can be theemail
address or theunique_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.
-
(::String) — 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}
or not providing one at all will infer the project from the account. The{account}
value can be theemail
address or theunique_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
def source_contents() -> ::String
- (::String) — Workflow code to be executed. The size limit is 128KB.
#source_contents=
def source_contents=(value) -> ::String
- value (::String) — Workflow code to be executed. The size limit is 128KB.
- (::String) — Workflow code to be executed. The size limit is 128KB.
#state
def state() -> ::Google::Cloud::Workflows::V1::Workflow::State
- (::Google::Cloud::Workflows::V1::Workflow::State) — Output only. State of the workflow deployment.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The last update timestamp of the workflow.