Skip to main content

Class: WorkflowExecutionOptionsUpdatedEventAttributes

history.v1.WorkflowExecutionOptionsUpdatedEventAttributes

Represents a WorkflowExecutionOptionsUpdatedEventAttributes.

Properties​

attachedCompletionCallbacks​

• attachedCompletionCallbacks: $Properties[]

Completion callbacks attached to the running workflow execution.


attachedRequestId​

• attachedRequestId: string

Request ID attached to the running workflow execution so that subsequent requests with same request ID will be deduped.


identity​

• identity: string

Optional. The identity of the client who initiated the request that created this event.


priority​

• Optional priority: null | $Properties

Priority override upserted in this event. Represents the full priority; not just partial fields. Ignored if nil.


timeSkippingConfig​

• Optional timeSkippingConfig: null | $Properties

TimeSkippingConfig override upserted in this event. Represents the full config.


timeSkippingConfigUpdated​

• timeSkippingConfigUpdated: boolean

Indicates the time skipping config was updated by the recent call to update workflow execution options.


unsetVersioningOverride​

• unsetVersioningOverride: boolean

Versioning override removed in this event.


versioningOverride​

• Optional versioningOverride: null | $Properties

Versioning override upserted in this event. Ignored if nil or if unset_versioning_override is true.


workflowUpdateOptions​

• workflowUpdateOptions: $Properties[]

Updates to workflow updates options.

Methods​

toJSON​

▸ toJSON(): Object

Converts this WorkflowExecutionOptionsUpdatedEventAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): WorkflowExecutionOptionsUpdatedEventAttributes & $Shape

Creates a new WorkflowExecutionOptionsUpdatedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

WorkflowExecutionOptionsUpdatedEventAttributes & $Shape

WorkflowExecutionOptionsUpdatedEventAttributes instance

▸ create(properties?): WorkflowExecutionOptionsUpdatedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

WorkflowExecutionOptionsUpdatedEventAttributes


decode​

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

Decodes a WorkflowExecutionOptionsUpdatedEventAttributes message from the specified reader or buffer.

Parameters​

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

Returns​

WorkflowExecutionOptionsUpdatedEventAttributes & $Shape

WorkflowExecutionOptionsUpdatedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): WorkflowExecutionOptionsUpdatedEventAttributes & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

WorkflowExecutionOptionsUpdatedEventAttributes & $Shape

WorkflowExecutionOptionsUpdatedEventAttributes

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): WorkflowExecutionOptionsUpdatedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

WorkflowExecutionOptionsUpdatedEventAttributes

WorkflowExecutionOptionsUpdatedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageWorkflowExecutionOptionsUpdatedEventAttributesWorkflowExecutionOptionsUpdatedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object