Skip to main content

Class: WorkflowExecutionConfig

workflow.v1.WorkflowExecutionConfig

Represents a WorkflowExecutionConfig.

Implements

Constructors

constructor

new WorkflowExecutionConfig(properties?): WorkflowExecutionConfig

Constructs a new WorkflowExecutionConfig.

Parameters

NameTypeDescription
properties?IWorkflowExecutionConfigProperties to set

Returns

WorkflowExecutionConfig

Properties

defaultWorkflowTaskTimeout

Optional defaultWorkflowTaskTimeout: null | IDuration

WorkflowExecutionConfig defaultWorkflowTaskTimeout.

Implementation of

IWorkflowExecutionConfig.defaultWorkflowTaskTimeout


taskQueue

Optional taskQueue: null | ITaskQueue

WorkflowExecutionConfig taskQueue.

Implementation of

IWorkflowExecutionConfig.taskQueue


workflowExecutionTimeout

Optional workflowExecutionTimeout: null | IDuration

WorkflowExecutionConfig workflowExecutionTimeout.

Implementation of

IWorkflowExecutionConfig.workflowExecutionTimeout


workflowRunTimeout

Optional workflowRunTimeout: null | IDuration

WorkflowExecutionConfig workflowRunTimeout.

Implementation of

IWorkflowExecutionConfig.workflowRunTimeout

Methods

toJSON

toJSON(): Object

Converts this WorkflowExecutionConfig to JSON.

Returns

Object

JSON object


create

create(properties?): WorkflowExecutionConfig

Creates a new WorkflowExecutionConfig instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowExecutionConfigProperties to set

Returns

WorkflowExecutionConfig

WorkflowExecutionConfig instance


decode

decode(reader, length?): WorkflowExecutionConfig

Decodes a WorkflowExecutionConfig message from the specified reader or buffer.

Parameters

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

Returns

WorkflowExecutionConfig

WorkflowExecutionConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkflowExecutionConfig

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowExecutionConfig

WorkflowExecutionConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIWorkflowExecutionConfigWorkflowExecutionConfig message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIWorkflowExecutionConfigWorkflowExecutionConfig message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): WorkflowExecutionConfig

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkflowExecutionConfig

WorkflowExecutionConfig


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionConfig

Parameters

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

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageWorkflowExecutionConfigWorkflowExecutionConfig
options?IConversionOptionsConversion options

Returns

Object

Plain object