Skip to main content

Class: StartWorkflowExecutionRequest

workflowservice.v1.StartWorkflowExecutionRequest

Represents a StartWorkflowExecutionRequest.

Implements#

Constructors#

constructor#

new StartWorkflowExecutionRequest(properties?)

Constructs a new StartWorkflowExecutionRequest.

Parameters#

NameType
properties?IStartWorkflowExecutionRequest

Properties#

cronSchedule#

cronSchedule: string

StartWorkflowExecutionRequest cronSchedule.

Implementation of#

IStartWorkflowExecutionRequest.cronSchedule


header#

Optional header: null | IHeader

StartWorkflowExecutionRequest header.

Implementation of#

IStartWorkflowExecutionRequest.header


identity#

identity: string

StartWorkflowExecutionRequest identity.

Implementation of#

IStartWorkflowExecutionRequest.identity


input#

Optional input: null | IPayloads

StartWorkflowExecutionRequest input.

Implementation of#

IStartWorkflowExecutionRequest.input


memo#

Optional memo: null | IMemo

StartWorkflowExecutionRequest memo.

Implementation of#

IStartWorkflowExecutionRequest.memo


namespace#

namespace: string

StartWorkflowExecutionRequest namespace.

Implementation of#

IStartWorkflowExecutionRequest.namespace


requestId#

requestId: string

StartWorkflowExecutionRequest requestId.

Implementation of#

IStartWorkflowExecutionRequest.requestId


retryPolicy#

Optional retryPolicy: null | IRetryPolicy

StartWorkflowExecutionRequest retryPolicy.

Implementation of#

IStartWorkflowExecutionRequest.retryPolicy


searchAttributes#

Optional searchAttributes: null | ISearchAttributes

StartWorkflowExecutionRequest searchAttributes.

Implementation of#

IStartWorkflowExecutionRequest.searchAttributes


taskQueue#

Optional taskQueue: null | ITaskQueue

StartWorkflowExecutionRequest taskQueue.

Implementation of#

IStartWorkflowExecutionRequest.taskQueue


workflowExecutionTimeout#

Optional workflowExecutionTimeout: null | IDuration

StartWorkflowExecutionRequest workflowExecutionTimeout.

Implementation of#

IStartWorkflowExecutionRequest.workflowExecutionTimeout


workflowId#

workflowId: string

StartWorkflowExecutionRequest workflowId.

Implementation of#

IStartWorkflowExecutionRequest.workflowId


workflowIdReusePolicy#

workflowIdReusePolicy: WorkflowIdReusePolicy

StartWorkflowExecutionRequest workflowIdReusePolicy.

Implementation of#

IStartWorkflowExecutionRequest.workflowIdReusePolicy


workflowRunTimeout#

Optional workflowRunTimeout: null | IDuration

StartWorkflowExecutionRequest workflowRunTimeout.

Implementation of#

IStartWorkflowExecutionRequest.workflowRunTimeout


workflowTaskTimeout#

Optional workflowTaskTimeout: null | IDuration

StartWorkflowExecutionRequest workflowTaskTimeout.

Implementation of#

IStartWorkflowExecutionRequest.workflowTaskTimeout


workflowType#

Optional workflowType: null | IWorkflowType

StartWorkflowExecutionRequest workflowType.

Implementation of#

IStartWorkflowExecutionRequest.workflowType

Methods#

toJSON#

toJSON(): Object

Converts this StartWorkflowExecutionRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): StartWorkflowExecutionRequest

Decodes a StartWorkflowExecutionRequest 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#

StartWorkflowExecutionRequest

StartWorkflowExecutionRequest


decodeDelimited#

Static decodeDelimited(reader): StartWorkflowExecutionRequest

Decodes a StartWorkflowExecutionRequest 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#

StartWorkflowExecutionRequest

StartWorkflowExecutionRequest


encode#

Static encode(message, writer?): Writer

Encodes the specified StartWorkflowExecutionRequest message. Does not implicitly {@link temporal.api.workflowservice.v1.StartWorkflowExecutionRequest.verify|verify} messages.

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified StartWorkflowExecutionRequest message, length delimited. Does not implicitly {@link temporal.api.workflowservice.v1.StartWorkflowExecutionRequest.verify|verify} messages.

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): StartWorkflowExecutionRequest

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

StartWorkflowExecutionRequest

StartWorkflowExecutionRequest


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageStartWorkflowExecutionRequestStartWorkflowExecutionRequest
options?IConversionOptions-

Returns#

Object

Plain object