Class: TimerCanceledEventAttributes
history.v1.TimerCanceledEventAttributes
Represents a TimerCanceledEventAttributes.
Implements
Constructors
constructor
• new TimerCanceledEventAttributes(properties?
): TimerCanceledEventAttributes
Constructs a new TimerCanceledEventAttributes.
Parameters
Name | Type | Description |
---|---|---|
properties? | ITimerCanceledEventAttributes | Properties to set |
Returns
Properties
identity
• identity: string
The id of the worker who requested this cancel
Implementation of
ITimerCanceledEventAttributes.identity
startedEventId
• startedEventId: Long
The id of the TIMER_STARTED
event itself
Implementation of
ITimerCanceledEventAttributes.startedEventId
timerId
• timerId: string
Will match the timer_id
from TIMER_STARTED
event for this timer
Implementation of
ITimerCanceledEventAttributes.timerId
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED
event which this command was reported with
Implementation of
ITimerCanceledEventAttributes.workflowTaskCompletedEventId
Methods
toJSON
▸ toJSON(): Object
Converts this TimerCanceledEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): TimerCanceledEventAttributes
Creates a new TimerCanceledEventAttributes instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | ITimerCanceledEventAttributes | Properties to set |
Returns
TimerCanceledEventAttributes instance
decode
▸ decode(reader
, length?
): TimerCanceledEventAttributes
Decodes a TimerCanceledEventAttributes 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
TimerCanceledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): TimerCanceledEventAttributes
Decodes a TimerCanceledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TimerCanceledEventAttributes
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 TimerCanceledEventAttributes message. Does not implicitly temporal.api.history.v1.TimerCanceledEventAttributes.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | ITimerCanceledEventAttributes | TimerCanceledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified TimerCanceledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.TimerCanceledEventAttributes.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | ITimerCanceledEventAttributes | TimerCanceledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): TimerCanceledEventAttributes
Creates a TimerCanceledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
TimerCanceledEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for TimerCanceledEventAttributes
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 TimerCanceledEventAttributes message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | TimerCanceledEventAttributes | TimerCanceledEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object