Skip to main content

Class: DescribeTaskQueueRequest

workflowservice.v1.DescribeTaskQueueRequest

Represents a DescribeTaskQueueRequest.

Implements#

Constructors#

constructor#

new DescribeTaskQueueRequest(properties?)

Constructs a new DescribeTaskQueueRequest.

Parameters#

NameType
properties?IDescribeTaskQueueRequest

Properties#

includeTaskQueueStatus#

includeTaskQueueStatus: boolean

DescribeTaskQueueRequest includeTaskQueueStatus.

Implementation of#

IDescribeTaskQueueRequest.includeTaskQueueStatus


namespace#

namespace: string

DescribeTaskQueueRequest namespace.

Implementation of#

IDescribeTaskQueueRequest.namespace


taskQueue#

Optional taskQueue: null | ITaskQueue

DescribeTaskQueueRequest taskQueue.

Implementation of#

IDescribeTaskQueueRequest.taskQueue


taskQueueType#

taskQueueType: TaskQueueType

DescribeTaskQueueRequest taskQueueType.

Implementation of#

IDescribeTaskQueueRequest.taskQueueType

Methods#

toJSON#

toJSON(): Object

Converts this DescribeTaskQueueRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): DescribeTaskQueueRequest

Decodes a DescribeTaskQueueRequest 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#

DescribeTaskQueueRequest

DescribeTaskQueueRequest


decodeDelimited#

Static decodeDelimited(reader): DescribeTaskQueueRequest

Decodes a DescribeTaskQueueRequest 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#

DescribeTaskQueueRequest

DescribeTaskQueueRequest


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): DescribeTaskQueueRequest

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

DescribeTaskQueueRequest

DescribeTaskQueueRequest


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageDescribeTaskQueueRequestDescribeTaskQueueRequest
options?IConversionOptions-

Returns#

Object

Plain object