Skip to main content

Class: TimerStartedEventAttributes

Represents a TimerStartedEventAttributes.

Properties​

startToFireTimeout?​

optional startToFireTimeout?: $Properties | null

How long until this timer fires

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

timerId​

timerId: string

The worker/user assigned id for this timer

workflowTaskCompletedEventId​

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Methods​

toJSON()​

toJSON(): object

Converts this TimerStartedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TimerStartedEventAttributes & $Properties

Creates a new TimerStartedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimerStartedEventAttributes & $Properties

TimerStartedEventAttributes instance

Call Signature​

static create(properties?): TimerStartedEventAttributes

Creates a new TimerStartedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimerStartedEventAttributes

TimerStartedEventAttributes instance

decode()​

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

Decodes a TimerStartedEventAttributes 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​

TimerStartedEventAttributes & $Properties

TimerStartedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TimerStartedEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TimerStartedEventAttributes & $Properties

TimerStartedEventAttributes

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

Parameters​

message​

$Properties

TimerStartedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TimerStartedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TimerStartedEventAttributes

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

Parameters​

object​

Plain object

Returns​

TimerStartedEventAttributes

TimerStartedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TimerStartedEventAttributes

TimerStartedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object