Skip to main content

Class: UpdateWorkflowExecutionOptionsResponse

workflowservice.v1.UpdateWorkflowExecutionOptionsResponse

Represents an UpdateWorkflowExecutionOptionsResponse.

Properties​

updateTime​

• Optional updateTime: null | $Properties

The Workflow Execution time when the options were updated. When time skipping is enabled, this is the workflow's virtual time rather than wall-clock time.

This timestamp cannot be used for time-skipping fast-forward verification, use fast_forward_id in PollWorkflowExecutionTimeSkippingRequest instead.


workflowExecutionOptions​

• Optional workflowExecutionOptions: null | $Properties

Workflow Execution options after update.

Methods​

toJSON​

▸ toJSON(): Object

Converts this UpdateWorkflowExecutionOptionsResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): UpdateWorkflowExecutionOptionsResponse & $Shape

Creates a new UpdateWorkflowExecutionOptionsResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

UpdateWorkflowExecutionOptionsResponse & $Shape

UpdateWorkflowExecutionOptionsResponse instance

▸ create(properties?): UpdateWorkflowExecutionOptionsResponse

Parameters​

NameType
properties?$Properties

Returns​

UpdateWorkflowExecutionOptionsResponse


decode​

▸ decode(reader, length?): UpdateWorkflowExecutionOptionsResponse & $Shape

Decodes an UpdateWorkflowExecutionOptionsResponse message from the specified reader or buffer.

Parameters​

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

Returns​

UpdateWorkflowExecutionOptionsResponse & $Shape

UpdateWorkflowExecutionOptionsResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): UpdateWorkflowExecutionOptionsResponse & $Shape

Decodes an UpdateWorkflowExecutionOptionsResponse message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

UpdateWorkflowExecutionOptionsResponse & $Shape

UpdateWorkflowExecutionOptionsResponse

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 UpdateWorkflowExecutionOptionsResponse message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsResponse.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesUpdateWorkflowExecutionOptionsResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesUpdateWorkflowExecutionOptionsResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): UpdateWorkflowExecutionOptionsResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

UpdateWorkflowExecutionOptionsResponse

UpdateWorkflowExecutionOptionsResponse


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageUpdateWorkflowExecutionOptionsResponseUpdateWorkflowExecutionOptionsResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object