Skip to main content

Class: ClusterMetadata

Represents a ClusterMetadata.

Properties​

address​

address: string

gRPC address.

clusterId​

clusterId: string

Id of the cluster.

clusterName​

clusterName: string

Name of the cluster name.

historyShardCount​

historyShardCount: number

History service shard number.

httpAddress​

httpAddress: string

HTTP address, if one exists.

initialFailoverVersion​

initialFailoverVersion: Long

A unique failover version across all connected clusters.

isConnectionEnabled​

isConnectionEnabled: boolean

A flag to indicate if a connection is active.

isReplicationEnabled​

isReplicationEnabled: boolean

A flag to indicate if replication is enabled.

Methods​

toJSON()​

toJSON(): object

Converts this ClusterMetadata to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ClusterMetadata & $Properties

Creates a new ClusterMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ClusterMetadata & $Properties

ClusterMetadata instance

Call Signature​

static create(properties?): ClusterMetadata

Creates a new ClusterMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ClusterMetadata

ClusterMetadata instance

decode()​

static decode(reader, length?): ClusterMetadata & $Properties

Decodes a ClusterMetadata message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ClusterMetadata & $Properties

ClusterMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ClusterMetadata & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ClusterMetadata & $Properties

ClusterMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ClusterMetadata message. Does not implicitly temporal.api.operatorservice.v1.ClusterMetadata.verify|verify messages.

Parameters​

message​

$Properties

ClusterMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ClusterMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ClusterMetadata

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

Parameters​

object​

Plain object

Returns​

ClusterMetadata

ClusterMetadata

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ClusterMetadata

ClusterMetadata

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object