Skip to main content

Class: TimerCanceledEventAttributes

Represents a TimerCanceledEventAttributes.

Properties​

identity​

identity: string

The id of the worker who requested this cancel

startedEventId​

startedEventId: Long

The id of the TIMER_STARTED event itself

timerId​

timerId: string

Will match the timer_id from TIMER_STARTED event for this timer

workflowTaskCompletedEventId​

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Methods​

toJSON()​

toJSON(): object

Converts this TimerCanceledEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TimerCanceledEventAttributes & $Properties

Creates a new TimerCanceledEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimerCanceledEventAttributes & $Properties

TimerCanceledEventAttributes instance

Call Signature​

static create(properties?): TimerCanceledEventAttributes

Creates a new TimerCanceledEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimerCanceledEventAttributes

TimerCanceledEventAttributes instance

decode()​

static decode(reader, length?): TimerCanceledEventAttributes & $Properties

Decodes a TimerCanceledEventAttributes message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

TimerCanceledEventAttributes & $Properties

TimerCanceledEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TimerCanceledEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TimerCanceledEventAttributes & $Properties

TimerCanceledEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified TimerCanceledEventAttributes message. Does not implicitly temporal.api.history.v1.TimerCanceledEventAttributes.verify|verify messages.

Parameters​

message​

$Properties

TimerCanceledEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TimerCanceledEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TimerCanceledEventAttributes

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

TimerCanceledEventAttributes

TimerCanceledEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TimerCanceledEventAttributes

TimerCanceledEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object