Skip to main content

Class: TaskQueueInfo

v1.DeploymentInfo.TaskQueueInfo

Represents a TaskQueueInfo.

Properties​

firstPollerTime​

• Optional firstPollerTime: null | $Properties

When server saw the first poller for this task queue in this deployment.


name​

• name: string

TaskQueueInfo name.


type​

• type: TaskQueueType

TaskQueueInfo type.

Methods​

toJSON​

▸ toJSON(): Object

Converts this TaskQueueInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): TaskQueueInfo & $Properties

Creates a new TaskQueueInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

TaskQueueInfo & $Properties

TaskQueueInfo instance

▸ create(properties?): TaskQueueInfo

Parameters​

NameType
properties?$Properties

Returns​

TaskQueueInfo


decode​

▸ decode(reader, length?): TaskQueueInfo & $Properties

Decodes a TaskQueueInfo message from the specified reader or buffer.

Parameters​

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

Returns​

TaskQueueInfo & $Properties

TaskQueueInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): TaskQueueInfo & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

TaskQueueInfo & $Properties

TaskQueueInfo

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 TaskQueueInfo message. Does not implicitly temporal.api.deployment.v1.DeploymentInfo.TaskQueueInfo.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesTaskQueueInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified TaskQueueInfo message, length delimited. Does not implicitly temporal.api.deployment.v1.DeploymentInfo.TaskQueueInfo.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesTaskQueueInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): TaskQueueInfo

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

TaskQueueInfo

TaskQueueInfo


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageTaskQueueInfoTaskQueueInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object