Skip to main content

Class: ActivityTaskCanceledEventAttributes

history.v1.ActivityTaskCanceledEventAttributes

Represents an ActivityTaskCanceledEventAttributes.

Implements

Constructors

constructor

new ActivityTaskCanceledEventAttributes(properties?): ActivityTaskCanceledEventAttributes

Constructs a new ActivityTaskCanceledEventAttributes.

Parameters

NameTypeDescription
properties?IActivityTaskCanceledEventAttributesProperties to set

Returns

ActivityTaskCanceledEventAttributes

Properties

details

Optional details: null | IPayloads

Additional information that the activity reported upon confirming cancellation

Implementation of

IActivityTaskCanceledEventAttributes.details


identity

identity: string

id of the worker who canceled this activity

Implementation of

IActivityTaskCanceledEventAttributes.identity


latestCancelRequestedEventId

latestCancelRequestedEventId: Long

id of the most recent ACTIVITY_TASK_CANCEL_REQUESTED event which refers to the same activity

Implementation of

IActivityTaskCanceledEventAttributes.latestCancelRequestedEventId


scheduledEventId

scheduledEventId: Long

The id of the ACTIVITY_TASK_SCHEDULED event this cancel confirmation corresponds to

Implementation of

IActivityTaskCanceledEventAttributes.scheduledEventId


startedEventId

startedEventId: Long

The id of the ACTIVITY_TASK_STARTED event this cancel confirmation corresponds to

Implementation of

IActivityTaskCanceledEventAttributes.startedEventId


workerVersion

Optional workerVersion: null | IWorkerVersionStamp

Version info of the worker who processed this workflow task. Deprecated. Use the info inside the corresponding ActivityTaskStartedEvent

Implementation of

IActivityTaskCanceledEventAttributes.workerVersion

Methods

toJSON

toJSON(): Object

Converts this ActivityTaskCanceledEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): ActivityTaskCanceledEventAttributes

Creates a new ActivityTaskCanceledEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IActivityTaskCanceledEventAttributesProperties to set

Returns

ActivityTaskCanceledEventAttributes

ActivityTaskCanceledEventAttributes instance


decode

decode(reader, length?): ActivityTaskCanceledEventAttributes

Decodes an ActivityTaskCanceledEventAttributes message from the specified reader or buffer.

Parameters

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

Returns

ActivityTaskCanceledEventAttributes

ActivityTaskCanceledEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ActivityTaskCanceledEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ActivityTaskCanceledEventAttributes

ActivityTaskCanceledEventAttributes

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

Parameters

NameTypeDescription
messageIActivityTaskCanceledEventAttributesActivityTaskCanceledEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIActivityTaskCanceledEventAttributesActivityTaskCanceledEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ActivityTaskCanceledEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ActivityTaskCanceledEventAttributes

ActivityTaskCanceledEventAttributes


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ActivityTaskCanceledEventAttributes

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

Parameters

NameTypeDescription
messageActivityTaskCanceledEventAttributesActivityTaskCanceledEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object