Class: TaskQueueVersionInfo
Represents a TaskQueueVersionInfo.
Properties
taskReachability
taskReachability:
BuildIdTaskReachability
Task Reachability is eventually consistent; there may be a delay until it converges to the most accurate value but it is designed in a way to take the more conservative side until it converges. For example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY.
Note: future activities who inherit their workflow's Build ID but not its Task Queue will not be accounted for reachability as server cannot know if they'll happen as they do not use assignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows who inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make sure to query reachability for the parent/previous workflow's Task Queue as well.
typesInfo
typesInfo:
object
Task Queue info per Task Type. Key is the numerical value of the temporal.api.enums.v1.TaskQueueType enum.
Index Signature
[k: string]: $Properties
Methods
toJSON()
toJSON():
object
Converts this TaskQueueVersionInfo to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):TaskQueueVersionInfo&$Properties
Creates a new TaskQueueVersionInfo instance using the specified properties.
Parameters
properties?
Properties to set
Returns
TaskQueueVersionInfo & $Properties
TaskQueueVersionInfo instance
Call Signature
staticcreate(properties?):TaskQueueVersionInfo
Creates a new TaskQueueVersionInfo instance using the specified properties.
Parameters
properties?
Properties to set
Returns
TaskQueueVersionInfo
TaskQueueVersionInfo instance
decode()
staticdecode(reader,length?):TaskQueueVersionInfo&$Properties
Decodes a TaskQueueVersionInfo 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
TaskQueueVersionInfo & $Properties
TaskQueueVersionInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):TaskQueueVersionInfo&$Properties
Decodes a TaskQueueVersionInfo message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
TaskQueueVersionInfo & $Properties
TaskQueueVersionInfo
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 TaskQueueVersionInfo message. Does not implicitly temporal.api.taskqueue.v1.TaskQueueVersionInfo.verify|verify messages.
Parameters
message
TaskQueueVersionInfo message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified TaskQueueVersionInfo message, length delimited. Does not implicitly temporal.api.taskqueue.v1.TaskQueueVersionInfo.verify|verify messages.
Parameters
message
TaskQueueVersionInfo message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):TaskQueueVersionInfo
Creates a TaskQueueVersionInfo message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
TaskQueueVersionInfo
TaskQueueVersionInfo
toObject()
statictoObject(message,options?):object
Creates a plain object from a TaskQueueVersionInfo message. Also converts values to other types if specified.
Parameters
message
TaskQueueVersionInfo
TaskQueueVersionInfo
options?
IConversionOptions
Conversion options
Returns
object
Plain object