Class: DescribeTaskQueueResponse

workflowservice.v1.DescribeTaskQueueResponse

Represents a DescribeTaskQueueResponse.

Implements

• IDescribeTaskQueueResponse

Constructors

constructor

• new DescribeTaskQueueResponse(properties?): DescribeTaskQueueResponse

Constructs a new DescribeTaskQueueResponse.

Parameters

Name	Type	Description
properties?	IDescribeTaskQueueResponse	Properties to set

Returns

DescribeTaskQueueResponse

Properties

pollers

• pollers: IPollerInfo[]

Deprecated. Use versions_info.types_info.pollers with ENHANCED mode instead. Not set in ENHANCED mode.

Implementation of

IDescribeTaskQueueResponse.pollers

---

taskQueueStatus

• Optional taskQueueStatus: null | ITaskQueueStatus

Deprecated. Not set in ENHANCED mode.

Implementation of

IDescribeTaskQueueResponse.taskQueueStatus

---

versionsInfo

• versionsInfo: Object

This map contains Task Queue information for each Build ID. Empty string as key value means unversioned. Only set in ENHANCED mode.

Index signature

▪ [k: string]: ITaskQueueVersionInfo

Implementation of

IDescribeTaskQueueResponse.versionsInfo

Methods

toJSON

▸ toJSON(): Object

Converts this DescribeTaskQueueResponse to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): DescribeTaskQueueResponse

Creates a new DescribeTaskQueueResponse instance using the specified properties.

Parameters

Name	Type	Description
properties?	IDescribeTaskQueueResponse	Properties to set

Returns

DescribeTaskQueueResponse

DescribeTaskQueueResponse instance

---

decode

▸ decode(reader, length?): DescribeTaskQueueResponse

Decodes a DescribeTaskQueueResponse message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

DescribeTaskQueueResponse

DescribeTaskQueueResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): DescribeTaskQueueResponse

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

DescribeTaskQueueResponse

DescribeTaskQueueResponse

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

Parameters

Name	Type	Description
message	IDescribeTaskQueueResponse	DescribeTaskQueueResponse message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IDescribeTaskQueueResponse	DescribeTaskQueueResponse message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): DescribeTaskQueueResponse

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

DescribeTaskQueueResponse

DescribeTaskQueueResponse

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeTaskQueueResponse

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	DescribeTaskQueueResponse	DescribeTaskQueueResponse
options?	IConversionOptions	Conversion options

Returns

Object

Plain object