Skip to main content

Class: ActivityTaskCompletedEventAttributes

history.v1.ActivityTaskCompletedEventAttributes

Represents an ActivityTaskCompletedEventAttributes.

Properties

identity

identity: string

id of the worker that completed this task


result

Optional result: null | $Properties

Serialized results of the activity. IE: The return value of the activity function


scheduledEventId

scheduledEventId: Long

The id of the ACTIVITY_TASK_SCHEDULED event this completion corresponds to


startedEventId

startedEventId: Long

The id of the ACTIVITY_TASK_STARTED event this completion corresponds to


workerVersion

Optional workerVersion: null | $Properties

Version info of the worker who processed this workflow task. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

Methods

toJSON

toJSON(): Object

Converts this ActivityTaskCompletedEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): ActivityTaskCompletedEventAttributes & $Properties

Creates a new ActivityTaskCompletedEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

ActivityTaskCompletedEventAttributes & $Properties

ActivityTaskCompletedEventAttributes instance

create(properties?): ActivityTaskCompletedEventAttributes

Parameters

NameType
properties?$Properties

Returns

ActivityTaskCompletedEventAttributes


decode

decode(reader, length?): ActivityTaskCompletedEventAttributes & $Properties

Decodes an ActivityTaskCompletedEventAttributes message from the specified reader or buffer.

Parameters

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

Returns

ActivityTaskCompletedEventAttributes & $Properties

ActivityTaskCompletedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ActivityTaskCompletedEventAttributes & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ActivityTaskCompletedEventAttributes & $Properties

ActivityTaskCompletedEventAttributes

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ActivityTaskCompletedEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ActivityTaskCompletedEventAttributes

ActivityTaskCompletedEventAttributes


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageActivityTaskCompletedEventAttributesActivityTaskCompletedEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object