Workflow

google.cloud.workflows.v1. Workflow

Represents a Workflow.

Constructor

new Workflow(propertiesopt)

Constructs a new Workflow.

Parameters:
Name Type Attributes Description
properties google.cloud.workflows.v1.IWorkflow <optional>

Properties to set

Implements:
  • IWorkflow

Members

createTime

Workflow createTime.

description

Workflow description.

labels

Workflow labels.

name

Workflow name.

revisionCreateTime

Workflow revisionCreateTime.

revisionId

Workflow revisionId.

serviceAccount

Workflow serviceAccount.

sourceCode

Workflow sourceCode.

sourceContents

Workflow sourceContents.

state

Workflow state.

updateTime

Workflow updateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ACTIVE number

ACTIVE value

Methods

toJSON() → {Object.<string, *>}

Converts this Workflow to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.workflows.v1.Workflow}

Creates a new Workflow instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.workflows.v1.IWorkflow <optional>

Properties to set

Returns:
Type Description
google.cloud.workflows.v1.Workflow

Workflow instance

(static) decode(reader, lengthopt) → {google.cloud.workflows.v1.Workflow}

Decodes a Workflow message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.workflows.v1.Workflow

Workflow

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.workflows.v1.Workflow}

Decodes a Workflow message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.workflows.v1.Workflow

Workflow

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Workflow message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.workflows.v1.IWorkflow

Workflow message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Workflow message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.workflows.v1.IWorkflow

Workflow message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.workflows.v1.Workflow}

Creates a Workflow message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.workflows.v1.Workflow

Workflow

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Workflow

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Workflow message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.workflows.v1.Workflow

Workflow

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Workflow message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not