Skip to main content

Class: TaskQueueMetadata

taskqueue.v1.TaskQueueMetadata

Represents a TaskQueueMetadata.

Implements#

Constructors#

constructor#

new TaskQueueMetadata(properties?)

Constructs a new TaskQueueMetadata.

Parameters#

NameType
properties?ITaskQueueMetadata

Properties#

maxTasksPerSecond#

Optional maxTasksPerSecond: null | IDoubleValue

TaskQueueMetadata maxTasksPerSecond.

Implementation of#

ITaskQueueMetadata.maxTasksPerSecond

Methods#

toJSON#

toJSON(): Object

Converts this TaskQueueMetadata to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): TaskQueueMetadata

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

TaskQueueMetadata

TaskQueueMetadata


decodeDelimited#

Static decodeDelimited(reader): TaskQueueMetadata

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

TaskQueueMetadata

TaskQueueMetadata


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): TaskQueueMetadata

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

TaskQueueMetadata

TaskQueueMetadata


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageTaskQueueMetadataTaskQueueMetadata
options?IConversionOptions-

Returns#

Object

Plain object