Class: TriggerImmediatelyRequest
Represents a TriggerImmediatelyRequest.
Properties
overlapPolicy
overlapPolicy:
ScheduleOverlapPolicy
If set, override overlap policy for this one request.
scheduledTime?
optionalscheduledTime?:$Properties|null
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()
Call Signature
staticcreate(properties?):TriggerImmediatelyRequest&$Properties
Creates a new TriggerImmediatelyRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
TriggerImmediatelyRequest & $Properties
TriggerImmediatelyRequest instance
Call Signature
staticcreate(properties?):TriggerImmediatelyRequest
Creates a new TriggerImmediatelyRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
TriggerImmediatelyRequest
TriggerImmediatelyRequest instance
decode()
staticdecode(reader,length?):TriggerImmediatelyRequest&$Properties
Decodes a TriggerImmediatelyRequest 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
TriggerImmediatelyRequest & $Properties
TriggerImmediatelyRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):TriggerImmediatelyRequest&$Properties
Decodes a TriggerImmediatelyRequest message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | 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()
staticencode(message,writer?):Writer
Encodes the specified TriggerImmediatelyRequest message. Does not implicitly temporal.api.schedule.v1.TriggerImmediatelyRequest.verify|verify messages.
Parameters
message
TriggerImmediatelyRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified TriggerImmediatelyRequest message, length delimited. Does not implicitly temporal.api.schedule.v1.TriggerImmediatelyRequest.verify|verify messages.
Parameters
message
TriggerImmediatelyRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):TriggerImmediatelyRequest
Creates a TriggerImmediatelyRequest message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
TriggerImmediatelyRequest
TriggerImmediatelyRequest
toObject()
statictoObject(message,options?):object
Creates a plain object from a TriggerImmediatelyRequest message. Also converts values to other types if specified.
Parameters
message
TriggerImmediatelyRequest
TriggerImmediatelyRequest
options?
IConversionOptions
Conversion options
Returns
object
Plain object