Skip to main content

Class: TaskQueuePartitionMetadata

taskqueue.v1.TaskQueuePartitionMetadata

Represents a TaskQueuePartitionMetadata.

Properties​

key​

• key: string

TaskQueuePartitionMetadata key.


ownerHostName​

• ownerHostName: string

TaskQueuePartitionMetadata ownerHostName.

Methods​

toJSON​

▸ toJSON(): Object

Converts this TaskQueuePartitionMetadata to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): TaskQueuePartitionMetadata & $Properties

Creates a new TaskQueuePartitionMetadata instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

TaskQueuePartitionMetadata & $Properties

TaskQueuePartitionMetadata instance

▸ create(properties?): TaskQueuePartitionMetadata

Parameters​

NameType
properties?$Properties

Returns​

TaskQueuePartitionMetadata


decode​

▸ decode(reader, length?): TaskQueuePartitionMetadata & $Properties

Decodes a TaskQueuePartitionMetadata message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

TaskQueuePartitionMetadata & $Properties

TaskQueuePartitionMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): TaskQueuePartitionMetadata & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

TaskQueuePartitionMetadata & $Properties

TaskQueuePartitionMetadata

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

Parameters​

NameTypeDescription
message$PropertiesTaskQueuePartitionMetadata message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesTaskQueuePartitionMetadata message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ 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​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageTaskQueuePartitionMetadataTaskQueuePartitionMetadata
options?IConversionOptionsConversion options

Returns​

Object

Plain object