Skip to main content

Class: NewWorkflowExecutionInfo

NewWorkflowExecutionInfo is a shared message that encapsulates all the required arguments to starting a workflow in different contexts.

Properties​

cronSchedule​

cronSchedule: string

See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/

optional header?: $Properties | null

NewWorkflowExecutionInfo header.

input?​

optional input?: $Properties | null

Serialized arguments to the workflow.

memo?​

optional memo?: $Properties | null

NewWorkflowExecutionInfo memo.

priority?​

optional priority?: $Properties | null

Priority metadata

retryPolicy?​

optional retryPolicy?: $Properties | null

The retry policy for the workflow. Will never exceed workflow_execution_timeout.

searchAttributes?​

optional searchAttributes?: $Properties | null

NewWorkflowExecutionInfo searchAttributes.

taskQueue?​

optional taskQueue?: $Properties | null

NewWorkflowExecutionInfo taskQueue.

userMetadata?​

optional userMetadata?: $Properties | null

Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig for use by user interfaces to display the fixed as-of-start summary and details of the workflow.

versioningOverride?​

optional versioningOverride?: $Properties | null

If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion. To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

Total workflow execution timeout including retries and continue as new.

workflowId​

workflowId: string

NewWorkflowExecutionInfo workflowId.

workflowIdReusePolicy​

workflowIdReusePolicy: WorkflowIdReusePolicy

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

Timeout of a single workflow run.

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

workflowType?​

optional workflowType?: $Properties | null

NewWorkflowExecutionInfo workflowType.

Methods​

toJSON()​

toJSON(): object

Converts this NewWorkflowExecutionInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NewWorkflowExecutionInfo & $Shape

Creates a new NewWorkflowExecutionInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

NewWorkflowExecutionInfo & $Shape

NewWorkflowExecutionInfo instance

Call Signature​

static create(properties?): NewWorkflowExecutionInfo

Creates a new NewWorkflowExecutionInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NewWorkflowExecutionInfo

NewWorkflowExecutionInfo instance

decode()​

static decode(reader, length?): NewWorkflowExecutionInfo & $Shape

Decodes a NewWorkflowExecutionInfo message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

NewWorkflowExecutionInfo & $Shape

NewWorkflowExecutionInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NewWorkflowExecutionInfo & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NewWorkflowExecutionInfo & $Shape

NewWorkflowExecutionInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified NewWorkflowExecutionInfo message. Does not implicitly temporal.api.workflow.v1.NewWorkflowExecutionInfo.verify|verify messages.

Parameters​

message​

$Properties

NewWorkflowExecutionInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified NewWorkflowExecutionInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.NewWorkflowExecutionInfo.verify|verify messages.

Parameters​

message​

$Properties

NewWorkflowExecutionInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NewWorkflowExecutionInfo

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

Parameters​

object​

Plain object

Returns​

NewWorkflowExecutionInfo

NewWorkflowExecutionInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NewWorkflowExecutionInfo

NewWorkflowExecutionInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object