Skip to main content

Class: NewWorkflowExecutionInfo

workflow.v1.NewWorkflowExecutionInfo

Represents a NewWorkflowExecutionInfo.

Implements

Constructors

constructor

new NewWorkflowExecutionInfo(properties?)

Constructs a new NewWorkflowExecutionInfo.

Parameters

NameTypeDescription
properties?INewWorkflowExecutionInfoProperties to set

Properties

cronSchedule

cronSchedule: string

NewWorkflowExecutionInfo cronSchedule.

Implementation of

INewWorkflowExecutionInfo.cronSchedule


Optional header: null | IHeader

NewWorkflowExecutionInfo header.

Implementation of

INewWorkflowExecutionInfo.header


input

Optional input: null | IPayloads

NewWorkflowExecutionInfo input.

Implementation of

INewWorkflowExecutionInfo.input


memo

Optional memo: null | IMemo

NewWorkflowExecutionInfo memo.

Implementation of

INewWorkflowExecutionInfo.memo


retryPolicy

Optional retryPolicy: null | IRetryPolicy

NewWorkflowExecutionInfo retryPolicy.

Implementation of

INewWorkflowExecutionInfo.retryPolicy


searchAttributes

Optional searchAttributes: null | ISearchAttributes

NewWorkflowExecutionInfo searchAttributes.

Implementation of

INewWorkflowExecutionInfo.searchAttributes


taskQueue

Optional taskQueue: null | ITaskQueue

NewWorkflowExecutionInfo taskQueue.

Implementation of

INewWorkflowExecutionInfo.taskQueue


workflowExecutionTimeout

Optional workflowExecutionTimeout: null | IDuration

NewWorkflowExecutionInfo workflowExecutionTimeout.

Implementation of

INewWorkflowExecutionInfo.workflowExecutionTimeout


workflowId

workflowId: string

NewWorkflowExecutionInfo workflowId.

Implementation of

INewWorkflowExecutionInfo.workflowId


workflowIdReusePolicy

workflowIdReusePolicy: WorkflowIdReusePolicy

NewWorkflowExecutionInfo workflowIdReusePolicy.

Implementation of

INewWorkflowExecutionInfo.workflowIdReusePolicy


workflowRunTimeout

Optional workflowRunTimeout: null | IDuration

NewWorkflowExecutionInfo workflowRunTimeout.

Implementation of

INewWorkflowExecutionInfo.workflowRunTimeout


workflowTaskTimeout

Optional workflowTaskTimeout: null | IDuration

NewWorkflowExecutionInfo workflowTaskTimeout.

Implementation of

INewWorkflowExecutionInfo.workflowTaskTimeout


workflowType

Optional workflowType: null | IWorkflowType

NewWorkflowExecutionInfo workflowType.

Implementation of

INewWorkflowExecutionInfo.workflowType

Methods

toJSON

toJSON(): Object

Converts this NewWorkflowExecutionInfo to JSON.

Returns

Object

JSON object


create

Static create(properties?): NewWorkflowExecutionInfo

Creates a new NewWorkflowExecutionInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?INewWorkflowExecutionInfoProperties to set

Returns

NewWorkflowExecutionInfo

NewWorkflowExecutionInfo instance


decode

Static decode(reader, length?): NewWorkflowExecutionInfo

Decodes a NewWorkflowExecutionInfo message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

NewWorkflowExecutionInfo

NewWorkflowExecutionInfo


decodeDelimited

Static decodeDelimited(reader): NewWorkflowExecutionInfo

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

NewWorkflowExecutionInfo

NewWorkflowExecutionInfo


encode

Static encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageINewWorkflowExecutionInfoNewWorkflowExecutionInfo message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageINewWorkflowExecutionInfoNewWorkflowExecutionInfo message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

NewWorkflowExecutionInfo

NewWorkflowExecutionInfo


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for NewWorkflowExecutionInfo

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageNewWorkflowExecutionInfoNewWorkflowExecutionInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object