Class: DescribeTaskQueueResponse
workflowservice.v1.DescribeTaskQueueResponse
Represents a DescribeTaskQueueResponse.
Implements
Constructors
constructor
• new DescribeTaskQueueResponse(properties?): DescribeTaskQueueResponse
Constructs a new DescribeTaskQueueResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeTaskQueueResponse | Properties to set |
Returns
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
create
▸ create(properties?): DescribeTaskQueueResponse
Creates a new DescribeTaskQueueResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeTaskQueueResponse | Properties to set |
Returns
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
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
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
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