Skip to main content

Class: WorkflowPropertiesModifiedEventAttributes

history.v1.WorkflowPropertiesModifiedEventAttributes

Represents a WorkflowPropertiesModifiedEventAttributes.

Properties​

upsertedMemo​

• Optional upsertedMemo: null | $Properties

If set, update the workflow memo with the provided values. The values will be merged with the existing memo. If the user wants to delete values, a default/empty Payload should be used as the value for the key being deleted.


workflowTaskCompletedEventId​

• workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Methods​

toJSON​

▸ toJSON(): Object

Converts this WorkflowPropertiesModifiedEventAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): WorkflowPropertiesModifiedEventAttributes & $Properties

Creates a new WorkflowPropertiesModifiedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

WorkflowPropertiesModifiedEventAttributes & $Properties

WorkflowPropertiesModifiedEventAttributes instance

▸ create(properties?): WorkflowPropertiesModifiedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

WorkflowPropertiesModifiedEventAttributes


decode​

▸ decode(reader, length?): WorkflowPropertiesModifiedEventAttributes & $Properties

Decodes a WorkflowPropertiesModifiedEventAttributes message from the specified reader or buffer.

Parameters​

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

Returns​

WorkflowPropertiesModifiedEventAttributes & $Properties

WorkflowPropertiesModifiedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): WorkflowPropertiesModifiedEventAttributes & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

WorkflowPropertiesModifiedEventAttributes & $Properties

WorkflowPropertiesModifiedEventAttributes

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): WorkflowPropertiesModifiedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

WorkflowPropertiesModifiedEventAttributes

WorkflowPropertiesModifiedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageWorkflowPropertiesModifiedEventAttributesWorkflowPropertiesModifiedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object