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