public sealed class Workflow : IMessage<Workflow>, IEquatable<Workflow>, IDeepCloneable<Workflow>, IBufferMessage, IMessageReference documentation and code samples for the Workflows v1 API class Workflow.
Workflow program to be executed by Workflows.
Namespace
Google.Cloud.Workflows.V1Assembly
Google.Cloud.Workflows.V1.dll
Constructors
Workflow()
public Workflow()Workflow(Workflow)
public Workflow(Workflow other)| Parameter | |
|---|---|
| Name | Description |
other | Workflow |
Properties
CallLogLevel
public Workflow.Types.CallLogLevel CallLogLevel { get; set; }Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
| Property Value | |
|---|---|
| Type | Description |
WorkflowTypesCallLogLevel | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. The timestamp for when the workflow was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
CryptoKeyName
public string CryptoKeyName { get; set; }Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow.
Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}
Using - as a wildcard for the {project} or not providing one at all
will infer the project from the account.
If not provided, data associated with the workflow will not be CMEK-encrypted.
| Property Value | |
|---|---|
| Type | Description |
string | |
CryptoKeyNameAsCryptoKeyName
public CryptoKeyName CryptoKeyNameAsCryptoKeyName { get; set; }CryptoKeyName-typed view over the CryptoKeyName resource name property.
| Property Value | |
|---|---|
| Type | Description |
CryptoKeyName | |
Description
public string Description { get; set; }Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
| Property Value | |
|---|---|
| Type | Description |
string | |
HasSourceContents
public bool HasSourceContents { get; }Gets whether the "source_contents" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
Name
public string Name { get; set; }The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
| Property Value | |
|---|---|
| Type | Description |
string | |
RevisionCreateTime
public Timestamp RevisionCreateTime { get; set; }Output only. The timestamp for the latest revision of the workflow's creation.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
RevisionId
public string RevisionId { get; set; }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:
- [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 six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
| Property Value | |
|---|---|
| Type | Description |
string | |
ServiceAccount
public string ServiceAccount { get; set; }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 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.
| Property Value | |
|---|---|
| Type | Description |
string | |
SourceCodeCase
public Workflow.SourceCodeOneofCase SourceCodeCase { get; }| Property Value | |
|---|---|
| Type | Description |
WorkflowSourceCodeOneofCase | |
SourceContents
public string SourceContents { get; set; }Workflow code to be executed. The size limit is 128KB.
| Property Value | |
|---|---|
| Type | Description |
string | |
State
public Workflow.Types.State State { get; set; }Output only. State of the workflow deployment.
| Property Value | |
|---|---|
| Type | Description |
WorkflowTypesState | |
StateError
public Workflow.Types.StateError StateError { get; set; }Output only. Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
| Property Value | |
|---|---|
| Type | Description |
WorkflowTypesStateError | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The timestamp for when the workflow was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
UserEnvVars
public MapField<string, string> UserEnvVars { get; }Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
WorkflowName
public WorkflowName WorkflowName { get; set; }Google.Cloud.Workflows.Common.V1.WorkflowName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
Google.Cloud.Workflows.Common.V1.WorkflowName | |