Skip to main content

Class: ClusterMetadata

operatorservice.v1.ClusterMetadata

Represents a ClusterMetadata.

Implements

Constructors

constructor

new ClusterMetadata(properties?): ClusterMetadata

Constructs a new ClusterMetadata.

Parameters

NameTypeDescription
properties?IClusterMetadataProperties to set

Returns

ClusterMetadata

Properties

address

address: string

gRPC address.

Implementation of

IClusterMetadata.address


clusterId

clusterId: string

Id of the cluster.

Implementation of

IClusterMetadata.clusterId


clusterName

clusterName: string

Name of the cluster name.

Implementation of

IClusterMetadata.clusterName


historyShardCount

historyShardCount: number

History service shard number.

Implementation of

IClusterMetadata.historyShardCount


httpAddress

httpAddress: string

HTTP address, if one exists.

Implementation of

IClusterMetadata.httpAddress


initialFailoverVersion

initialFailoverVersion: Long

A unique failover version across all connected clusters.

Implementation of

IClusterMetadata.initialFailoverVersion


isConnectionEnabled

isConnectionEnabled: boolean

A flag to indicate if a connection is active.

Implementation of

IClusterMetadata.isConnectionEnabled

Methods

toJSON

toJSON(): Object

Converts this ClusterMetadata to JSON.

Returns

Object

JSON object


create

create(properties?): ClusterMetadata

Creates a new ClusterMetadata instance using the specified properties.

Parameters

NameTypeDescription
properties?IClusterMetadataProperties to set

Returns

ClusterMetadata

ClusterMetadata instance


decode

decode(reader, length?): ClusterMetadata

Decodes a ClusterMetadata message from the specified reader or buffer.

Parameters

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

Returns

ClusterMetadata

ClusterMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ClusterMetadata

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ClusterMetadata

ClusterMetadata

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ClusterMetadata

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ClusterMetadata

ClusterMetadata


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ClusterMetadata

Parameters

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

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageClusterMetadataClusterMetadata
options?IConversionOptionsConversion options

Returns

Object

Plain object