Skip to main content

Class: TaskQueuePartitionMetadata

taskqueue.v1.TaskQueuePartitionMetadata

Represents a TaskQueuePartitionMetadata.

Implements#

Constructors#

constructor#

new TaskQueuePartitionMetadata(properties?)

Constructs a new TaskQueuePartitionMetadata.

Parameters#

NameType
properties?ITaskQueuePartitionMetadata

Properties#

key#

key: string

TaskQueuePartitionMetadata key.

Implementation of#

ITaskQueuePartitionMetadata.key


ownerHostName#

ownerHostName: string

TaskQueuePartitionMetadata ownerHostName.

Implementation of#

ITaskQueuePartitionMetadata.ownerHostName

Methods#

toJSON#

toJSON(): Object

Converts this TaskQueuePartitionMetadata to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): TaskQueuePartitionMetadata

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

TaskQueuePartitionMetadata

TaskQueuePartitionMetadata


decodeDelimited#

Static decodeDelimited(reader): TaskQueuePartitionMetadata

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

TaskQueuePartitionMetadata

TaskQueuePartitionMetadata


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): TaskQueuePartitionMetadata

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

TaskQueuePartitionMetadata

TaskQueuePartitionMetadata


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageTaskQueuePartitionMetadataTaskQueuePartitionMetadata
options?IConversionOptions-

Returns#

Object

Plain object