Class: TimerStartedEventAttributes

history.v1.TimerStartedEventAttributes

Represents a TimerStartedEventAttributes.

Implements

• ITimerStartedEventAttributes

Constructors

constructor

• new TimerStartedEventAttributes(properties?): TimerStartedEventAttributes

Constructs a new TimerStartedEventAttributes.

Parameters

Name	Type	Description
properties?	ITimerStartedEventAttributes	Properties to set

Returns

TimerStartedEventAttributes

Properties

startToFireTimeout

• Optional startToFireTimeout: null | IDuration

How long until this timer fires

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

Implementation of

ITimerStartedEventAttributes.startToFireTimeout

---

timerId

• timerId: string

The worker/user assigned id for this timer

Implementation of

ITimerStartedEventAttributes.timerId

---

workflowTaskCompletedEventId

• workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Implementation of

ITimerStartedEventAttributes.workflowTaskCompletedEventId

Methods

toJSON

▸ toJSON(): Object

Converts this TimerStartedEventAttributes to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TimerStartedEventAttributes

Creates a new TimerStartedEventAttributes instance using the specified properties.

Parameters

Name	Type	Description
properties?	ITimerStartedEventAttributes	Properties to set

Returns

TimerStartedEventAttributes

TimerStartedEventAttributes instance

---

decode

▸ decode(reader, length?): TimerStartedEventAttributes

Decodes a TimerStartedEventAttributes message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

TimerStartedEventAttributes

TimerStartedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): TimerStartedEventAttributes

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

TimerStartedEventAttributes

TimerStartedEventAttributes

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

Parameters

Name	Type	Description
message	ITimerStartedEventAttributes	TimerStartedEventAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITimerStartedEventAttributes	TimerStartedEventAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TimerStartedEventAttributes

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TimerStartedEventAttributes

TimerStartedEventAttributes

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TimerStartedEventAttributes

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	TimerStartedEventAttributes	TimerStartedEventAttributes
options?	IConversionOptions	Conversion options

Returns

Object

Plain object