Skip to main content

Class: TaskQueueVersionInfo

taskqueue.v1.TaskQueueVersionInfo

Represents a TaskQueueVersionInfo.

Implements

Constructors

constructor

new TaskQueueVersionInfo(properties?): TaskQueueVersionInfo

Constructs a new TaskQueueVersionInfo.

Parameters

NameTypeDescription
properties?ITaskQueueVersionInfoProperties to set

Returns

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.

Implementation of

ITaskQueueVersionInfo.taskReachability


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]: ITaskQueueTypeInfo

Implementation of

ITaskQueueVersionInfo.typesInfo

Methods

toJSON

toJSON(): Object

Converts this TaskQueueVersionInfo to JSON.

Returns

Object

JSON object


create

create(properties?): TaskQueueVersionInfo

Creates a new TaskQueueVersionInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?ITaskQueueVersionInfoProperties to set

Returns

TaskQueueVersionInfo

TaskQueueVersionInfo instance


decode

decode(reader, length?): TaskQueueVersionInfo

Decodes a TaskQueueVersionInfo message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

TaskQueueVersionInfo

TaskQueueVersionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): TaskQueueVersionInfo

Decodes a TaskQueueVersionInfo message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

TaskQueueVersionInfo

TaskQueueVersionInfo

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 TaskQueueVersionInfo message. Does not implicitly temporal.api.taskqueue.v1.TaskQueueVersionInfo.verify|verify messages.

Parameters

NameTypeDescription
messageITaskQueueVersionInfoTaskQueueVersionInfo message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified TaskQueueVersionInfo message, length delimited. Does not implicitly temporal.api.taskqueue.v1.TaskQueueVersionInfo.verify|verify messages.

Parameters

NameTypeDescription
messageITaskQueueVersionInfoTaskQueueVersionInfo message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): TaskQueueVersionInfo

Creates a TaskQueueVersionInfo message from a plain object. Also converts values to their respective internal types.

Parameters

NameTypeDescription
objectObjectPlain object

Returns

TaskQueueVersionInfo

TaskQueueVersionInfo


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TaskQueueVersionInfo

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

Creates a plain object from a TaskQueueVersionInfo message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageTaskQueueVersionInfoTaskQueueVersionInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object