Class: TaskQueueMetadata
taskqueue.v1.TaskQueueMetadata
Only applies to activity task queues
Implements
Constructors
constructor
• new TaskQueueMetadata(properties?): TaskQueueMetadata
Constructs a new TaskQueueMetadata.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITaskQueueMetadata | Properties to set |
Returns
Properties
maxTasksPerSecond
• Optional maxTasksPerSecond: null | IDoubleValue
Allows throttling dispatch of tasks from this queue
Implementation of
ITaskQueueMetadata.maxTasksPerSecond
Methods
toJSON
▸ toJSON(): Object
Converts this TaskQueueMetadata to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TaskQueueMetadata
Creates a new TaskQueueMetadata instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITaskQueueMetadata | Properties to set |
Returns
TaskQueueMetadata instance
decode
▸ decode(reader, length?): TaskQueueMetadata
Decodes a TaskQueueMetadata 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
TaskQueueMetadata
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TaskQueueMetadata
Decodes a TaskQueueMetadata message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TaskQueueMetadata
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 TaskQueueMetadata message. Does not implicitly temporal.api.taskqueue.v1.TaskQueueMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ITaskQueueMetadata | TaskQueueMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TaskQueueMetadata message, length delimited. Does not implicitly temporal.api.taskqueue.v1.TaskQueueMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ITaskQueueMetadata | TaskQueueMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TaskQueueMetadata
Creates a TaskQueueMetadata message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TaskQueueMetadata
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for TaskQueueMetadata
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 TaskQueueMetadata message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TaskQueueMetadata | TaskQueueMetadata |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object