Skip to main content

Class: WorkflowPropertiesModifiedEventAttributes

history.v1.WorkflowPropertiesModifiedEventAttributes

Represents a WorkflowPropertiesModifiedEventAttributes.

Implements

Constructors

constructor

new WorkflowPropertiesModifiedEventAttributes(properties?): WorkflowPropertiesModifiedEventAttributes

Constructs a new WorkflowPropertiesModifiedEventAttributes.

Parameters

NameTypeDescription
properties?IWorkflowPropertiesModifiedEventAttributesProperties to set

Returns

WorkflowPropertiesModifiedEventAttributes

Properties

upsertedMemo

Optional upsertedMemo: null | IMemo

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.

Implementation of

IWorkflowPropertiesModifiedEventAttributes.upsertedMemo


workflowTaskCompletedEventId

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Implementation of

IWorkflowPropertiesModifiedEventAttributes.workflowTaskCompletedEventId

Methods

toJSON

toJSON(): Object

Converts this WorkflowPropertiesModifiedEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): WorkflowPropertiesModifiedEventAttributes

Creates a new WorkflowPropertiesModifiedEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowPropertiesModifiedEventAttributesProperties to set

Returns

WorkflowPropertiesModifiedEventAttributes

WorkflowPropertiesModifiedEventAttributes instance


decode

decode(reader, length?): WorkflowPropertiesModifiedEventAttributes

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

WorkflowPropertiesModifiedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkflowPropertiesModifiedEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowPropertiesModifiedEventAttributes

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
messageIWorkflowPropertiesModifiedEventAttributesWorkflowPropertiesModifiedEventAttributes 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
messageIWorkflowPropertiesModifiedEventAttributesWorkflowPropertiesModifiedEventAttributes 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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowPropertiesModifiedEventAttributes

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 WorkflowPropertiesModifiedEventAttributes message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageWorkflowPropertiesModifiedEventAttributesWorkflowPropertiesModifiedEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object