Skip to main content

Class: WorkflowExecutionUpdateCompletedEventAttributes

history.v1.WorkflowExecutionUpdateCompletedEventAttributes

Represents a WorkflowExecutionUpdateCompletedEventAttributes.

Properties​

acceptedEventId​

• acceptedEventId: Long

The event ID indicating the acceptance of this update.


meta​

• Optional meta: null | $Properties

The metadata about this update.


outcome​

• Optional outcome: null | $Properties

The outcome of executing the workflow update function.

Methods​

toJSON​

▸ toJSON(): Object

Converts this WorkflowExecutionUpdateCompletedEventAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): WorkflowExecutionUpdateCompletedEventAttributes & $Shape

Creates a new WorkflowExecutionUpdateCompletedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

WorkflowExecutionUpdateCompletedEventAttributes & $Shape

WorkflowExecutionUpdateCompletedEventAttributes instance

▸ create(properties?): WorkflowExecutionUpdateCompletedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

WorkflowExecutionUpdateCompletedEventAttributes


decode​

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

Decodes a WorkflowExecutionUpdateCompletedEventAttributes message from the specified reader or buffer.

Parameters​

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

Returns​

WorkflowExecutionUpdateCompletedEventAttributes & $Shape

WorkflowExecutionUpdateCompletedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): WorkflowExecutionUpdateCompletedEventAttributes & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

WorkflowExecutionUpdateCompletedEventAttributes & $Shape

WorkflowExecutionUpdateCompletedEventAttributes

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): WorkflowExecutionUpdateCompletedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

WorkflowExecutionUpdateCompletedEventAttributes

WorkflowExecutionUpdateCompletedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageWorkflowExecutionUpdateCompletedEventAttributesWorkflowExecutionUpdateCompletedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object