Represents a Workflow.
Package
@google-cloud/workflows!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.workflows.v1.IWorkflow);
Constructs a new Workflow.
Type | Name | Description |
---|---|---|
IWorkflow | properties |
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Workflow createTime.
Type | Description |
---|---|
(google.protobuf.ITimestamp|null) |
description
public description: string;
Workflow description.
Type | Description |
---|---|
string |
labels
public labels: { [k: string]: string };
Workflow labels.
Type | Description |
---|---|
{ [k: string]: string } |
name
public name: string;
Workflow name.
Type | Description |
---|---|
string |
revisionCreateTime
public revisionCreateTime?: (google.protobuf.ITimestamp|null);
Workflow revisionCreateTime.
Type | Description |
---|---|
(google.protobuf.ITimestamp|null) |
revisionId
public revisionId: string;
Workflow revisionId.
Type | Description |
---|---|
string |
serviceAccount
public serviceAccount: string;
Workflow serviceAccount.
Type | Description |
---|---|
string |
sourceCode
public sourceCode?: "sourceContents";
Workflow sourceCode.
Type | Description |
---|---|
"sourceContents" |
sourceContents
public sourceContents?: (string|null);
Workflow sourceContents.
Type | Description |
---|---|
(string|null) |
state
public state: (google.cloud.workflows.v1.Workflow.State|keyof typeof google.cloud.workflows.v1.Workflow.State);
Workflow state.
Type | Description |
---|---|
(google.cloud.workflows.v1.Workflow.State|keyof typeof google.cloud.workflows.v1.Workflow.State) |
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
Workflow updateTime.
Type | Description |
---|---|
(google.protobuf.ITimestamp|null) |
Methods
create(properties)
public static create(properties?: google.cloud.workflows.v1.IWorkflow): google.cloud.workflows.v1.Workflow;
Creates a new Workflow instance using the specified properties.
Type | Name | Description |
---|---|---|
IWorkflow | properties |
Properties to set |
Type | Description |
---|---|
google.cloud.workflows.v1.Workflow | Workflow instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.workflows.v1.Workflow;
Decodes a Workflow message from the specified reader or buffer.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
number | length |
Message length if known beforehand |
Type | Description |
---|---|
google.cloud.workflows.v1.Workflow | Workflow |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.workflows.v1.Workflow;
Decodes a Workflow message from the specified reader or buffer, length delimited.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
Type | Description |
---|---|
google.cloud.workflows.v1.Workflow | Workflow |
encode(message, writer)
public static encode(message: google.cloud.workflows.v1.IWorkflow, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Workflow message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IWorkflow | message |
Workflow message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.workflows.v1.IWorkflow, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Workflow message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IWorkflow | message |
Workflow message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.workflows.v1.Workflow;
Creates a Workflow message from a plain object. Also converts values to their respective internal types.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | object |
Plain object |
Type | Description |
---|---|
google.cloud.workflows.v1.Workflow | Workflow |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Workflow to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.workflows.v1.Workflow, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Workflow message. Also converts values to other types if specified.
Type | Name | Description |
---|---|---|
google.cloud.workflows.v1.Workflow | message |
Workflow |
$protobuf.IConversionOptions | options |
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Workflow message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|