Class: StartTimerCommandAttributes
command.v1.StartTimerCommandAttributes
Represents a StartTimerCommandAttributes.
Properties
startToFireTimeout
• Optional startToFireTimeout: null | $Properties
How long until the timer fires, producing a TIMER_FIRED event.
(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
timerId
• timerId: string
An id for the timer, currently live timers must have different ids. Typically autogenerated by the SDK.
Methods
toJSON
▸ toJSON(): Object
Converts this StartTimerCommandAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartTimerCommandAttributes & $Properties
Creates a new StartTimerCommandAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
StartTimerCommandAttributes & $Properties
StartTimerCommandAttributes instance
▸ create(properties?): StartTimerCommandAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): StartTimerCommandAttributes & $Properties
Decodes a StartTimerCommandAttributes 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
StartTimerCommandAttributes & $Properties
StartTimerCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartTimerCommandAttributes & $Properties
Decodes a StartTimerCommandAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartTimerCommandAttributes & $Properties
StartTimerCommandAttributes
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 StartTimerCommandAttributes message. Does not implicitly temporal.api.command.v1.StartTimerCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StartTimerCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartTimerCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.StartTimerCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StartTimerCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartTimerCommandAttributes
Creates a StartTimerCommandAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartTimerCommandAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a StartTimerCommandAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartTimerCommandAttributes | StartTimerCommandAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object