Class: TriggerImmediatelyRequest
schedule.v1.TriggerImmediatelyRequest
Represents a TriggerImmediatelyRequest.
Properties
overlapPolicy
• overlapPolicy: ScheduleOverlapPolicy
If set, override overlap policy for this one request.
scheduledTime
• Optional scheduledTime: null | $Properties
Timestamp used for the identity of the target workflow. If not set the default value is the current time.
Methods
toJSON
▸ toJSON(): Object
Converts this TriggerImmediatelyRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TriggerImmediatelyRequest & $Properties
Creates a new TriggerImmediatelyRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
TriggerImmediatelyRequest & $Properties
TriggerImmediatelyRequest instance
▸ create(properties?): TriggerImmediatelyRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): TriggerImmediatelyRequest & $Properties
Decodes a TriggerImmediatelyRequest 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
TriggerImmediatelyRequest & $Properties
TriggerImmediatelyRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TriggerImmediatelyRequest & $Properties
Decodes a TriggerImmediatelyRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TriggerImmediatelyRequest & $Properties
TriggerImmediatelyRequest
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 TriggerImmediatelyRequest message. Does not implicitly temporal.api.schedule.v1.TriggerImmediatelyRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TriggerImmediatelyRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TriggerImmediatelyRequest message, length delimited. Does not implicitly temporal.api.schedule.v1.TriggerImmediatelyRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TriggerImmediatelyRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TriggerImmediatelyRequest
Creates a TriggerImmediatelyRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TriggerImmediatelyRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a TriggerImmediatelyRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TriggerImmediatelyRequest | TriggerImmediatelyRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object