Class Workflow

Workflow program to be executed by Workflows.

Inheritance
object
Workflow
Implements
Inherited Members
Namespace: Google.Apis.Workflows.v1.Data
Assembly: Google.Apis.Workflows.v1.dll
Syntax
public class Workflow : IDirectResponseSchema

Properties

AllKmsKeys

Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.

Declaration
[JsonProperty("allKmsKeys")]
public virtual IList<string> AllKmsKeys { get; set; }
Property Value
Type Description
IList<string>

AllKmsKeysVersions

Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.

Declaration
[JsonProperty("allKmsKeysVersions")]
public virtual IList<string> AllKmsKeysVersions { get; set; }
Property Value
Type Description
IList<string>

CallLogLevel

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.

Declaration
[JsonProperty("callLogLevel")]
public virtual string CallLogLevel { get; set; }
Property Value
Type Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

CryptoKeyName

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.

Declaration
[JsonProperty("cryptoKeyName")]
public virtual string CryptoKeyName { get; set; }
Property Value
Type Description
string

CryptoKeyVersion

Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}

Declaration
[JsonProperty("cryptoKeyVersion")]
public virtual string CryptoKeyVersion { get; set; }
Property Value
Type Description
string

Description

Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExecutionHistoryLevel

Optional. Describes the execution history level to apply to this workflow.

Declaration
[JsonProperty("executionHistoryLevel")]
public virtual string ExecutionHistoryLevel { get; set; }
Property Value
Type Description
string

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. This is a workflow-wide field and is not tied to a specific revision.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

RevisionCreateTime

object representation of RevisionCreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use RevisionCreateTimeDateTimeOffset instead.")]
public virtual object RevisionCreateTime { get; set; }
Property Value
Type Description
object

RevisionCreateTimeDateTimeOffset

DateTimeOffset representation of RevisionCreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? RevisionCreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

RevisionCreateTimeRaw

Output only. The timestamp for the latest revision of the workflow's creation.

Declaration
[JsonProperty("revisionCreateTime")]
public virtual string RevisionCreateTimeRaw { get; set; }
Property Value
Type Description
string

RevisionId

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 - Workflow code to be executed 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.

Declaration
[JsonProperty("revisionId")]
public virtual string RevisionId { get; set; }
Property Value
Type Description
string

ServiceAccount

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.

Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Type Description
string

SourceContents

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

Declaration
[JsonProperty("sourceContents")]
public virtual string SourceContents { get; set; }
Property Value
Type Description
string

State

Output only. State of the workflow deployment.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

StateError

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.

Declaration
[JsonProperty("stateError")]
public virtual StateError StateError { get; set; }
Property Value
Type Description
StateError

Tags

Optional. Input only. Immutable. Tags associated with this workflow.

Declaration
[JsonProperty("tags")]
public virtual IDictionary<string, string> Tags { get; set; }
Property Value
Type Description
IDictionary<string, string>

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

UserEnvVars

Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".

Declaration
[JsonProperty("userEnvVars")]
public virtual IDictionary<string, string> UserEnvVars { get; set; }
Property Value
Type Description
IDictionary<string, string>

Implements