Skip to main content

Class: StartWorkflow

coresdk.workflow_activation.StartWorkflow

Start a new workflow

Implements#

Constructors#

constructor#

new StartWorkflow(properties?)

Constructs a new StartWorkflow.

Parameters#

NameType
properties?IStartWorkflow

Properties#

arguments#

arguments: IPayload[]

Inputs to the workflow code

Implementation of#

IStartWorkflow.arguments


headers#

headers: Object

Used to add metadata e.g. for tracing and auth, meant to be read and written to by interceptors.

Index signature#

▪ [k: string]: IPayload

Implementation of#

IStartWorkflow.headers


randomnessSeed#

randomnessSeed: Long

RandomSeedUpdatedAttributes are used to deliver seed updates.

Implementation of#

IStartWorkflow.randomnessSeed


workflowId#

workflowId: string

The workflow id used on the temporal server

Implementation of#

IStartWorkflow.workflowId


workflowType#

workflowType: string

The identifier the lang-specific sdk uses to execute workflow code

Implementation of#

IStartWorkflow.workflowType

Methods#

toJSON#

toJSON(): Object

Converts this StartWorkflow to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): StartWorkflow

Decodes a StartWorkflow message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

StartWorkflow

StartWorkflow


decodeDelimited#

Static decodeDelimited(reader): StartWorkflow

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

StartWorkflow

StartWorkflow


encode#

Static encode(message, writer?): Writer

Encodes the specified StartWorkflow message. Does not implicitly {@link coresdk.workflow_activation.StartWorkflow.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStartWorkflowStartWorkflow message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified StartWorkflow message, length delimited. Does not implicitly {@link coresdk.workflow_activation.StartWorkflow.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStartWorkflowStartWorkflow message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): StartWorkflow

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

StartWorkflow

StartWorkflow


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageStartWorkflowStartWorkflow
options?IConversionOptions-

Returns#

Object

Plain object