Skip to main content

Class: DescribeTaskQueueResponse

workflowservice.v1.DescribeTaskQueueResponse

Represents a DescribeTaskQueueResponse.

Implements#

Constructors#

constructor#

new DescribeTaskQueueResponse(properties?)

Constructs a new DescribeTaskQueueResponse.

Parameters#

NameType
properties?IDescribeTaskQueueResponse

Properties#

pollers#

pollers: IPollerInfo[]

DescribeTaskQueueResponse pollers.

Implementation of#

IDescribeTaskQueueResponse.pollers


taskQueueStatus#

Optional taskQueueStatus: null | ITaskQueueStatus

DescribeTaskQueueResponse taskQueueStatus.

Implementation of#

IDescribeTaskQueueResponse.taskQueueStatus

Methods#

toJSON#

toJSON(): Object

Converts this DescribeTaskQueueResponse to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): DescribeTaskQueueResponse

Decodes a DescribeTaskQueueResponse message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

DescribeTaskQueueResponse

DescribeTaskQueueResponse


decodeDelimited#

Static decodeDelimited(reader): DescribeTaskQueueResponse

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

DescribeTaskQueueResponse

DescribeTaskQueueResponse


encode#

Static encode(message, writer?): Writer

Encodes the specified DescribeTaskQueueResponse message. Does not implicitly {@link temporal.api.workflowservice.v1.DescribeTaskQueueResponse.verify|verify} messages.

Parameters#

NameTypeDescription
messageIDescribeTaskQueueResponseDescribeTaskQueueResponse message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified DescribeTaskQueueResponse message, length delimited. Does not implicitly {@link temporal.api.workflowservice.v1.DescribeTaskQueueResponse.verify|verify} messages.

Parameters#

NameTypeDescription
messageIDescribeTaskQueueResponseDescribeTaskQueueResponse message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): DescribeTaskQueueResponse

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

DescribeTaskQueueResponse

DescribeTaskQueueResponse


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageDescribeTaskQueueResponseDescribeTaskQueueResponse
options?IConversionOptions-

Returns#

Object

Plain object