Skip to main content

Class: DescribeTaskQueueRequest

workflowservice.v1.DescribeTaskQueueRequest

Represents a DescribeTaskQueueRequest.

Implements

Constructors

constructor

new DescribeTaskQueueRequest(properties?)

Constructs a new DescribeTaskQueueRequest.

Parameters

NameTypeDescription
properties?IDescribeTaskQueueRequestProperties to set

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


create

Static create(properties?): DescribeTaskQueueRequest

Creates a new DescribeTaskQueueRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeTaskQueueRequestProperties to set

Returns

DescribeTaskQueueRequest

DescribeTaskQueueRequest instance


decode

Static decode(reader, length?): DescribeTaskQueueRequest

Decodes a DescribeTaskQueueRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

DescribeTaskQueueRequest

DescribeTaskQueueRequest


decodeDelimited

Static decodeDelimited(reader): DescribeTaskQueueRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

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 temporal.api.workflowservice.v1.DescribeTaskQueueRequest.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeTaskQueueRequest

Parameters

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

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object