Skip to main content

Class: TaskQueuePartitionMetadata

taskqueue.v1.TaskQueuePartitionMetadata

Represents a TaskQueuePartitionMetadata.

Implements

Constructors

constructor

new TaskQueuePartitionMetadata(properties?)

Constructs a new TaskQueuePartitionMetadata.

Parameters

NameTypeDescription
properties?ITaskQueuePartitionMetadataProperties to set

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


create

Static create(properties?): TaskQueuePartitionMetadata

Creates a new TaskQueuePartitionMetadata instance using the specified properties.

Parameters

NameTypeDescription
properties?ITaskQueuePartitionMetadataProperties to set

Returns

TaskQueuePartitionMetadata

TaskQueuePartitionMetadata instance


decode

Static decode(reader, length?): TaskQueuePartitionMetadata

Decodes a TaskQueuePartitionMetadata message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

TaskQueuePartitionMetadata

TaskQueuePartitionMetadata


decodeDelimited

Static decodeDelimited(reader): TaskQueuePartitionMetadata

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

Throws

If the payload is not a reader or valid buffer

Throws

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

Parameters

NameTypeDescription
messageITaskQueuePartitionMetadataTaskQueuePartitionMetadata message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageITaskQueuePartitionMetadataTaskQueuePartitionMetadata message or plain object to encode
writer?WriterWriter to encode to

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TaskQueuePartitionMetadata

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object