Skip to main content

Class: ClusterReplicationConfig

replication.v1.ClusterReplicationConfig

Represents a ClusterReplicationConfig.

Implements#

Constructors#

constructor#

new ClusterReplicationConfig(properties?)

Constructs a new ClusterReplicationConfig.

Parameters#

NameType
properties?IClusterReplicationConfig

Properties#

clusterName#

clusterName: string

ClusterReplicationConfig clusterName.

Implementation of#

IClusterReplicationConfig.clusterName

Methods#

toJSON#

toJSON(): Object

Converts this ClusterReplicationConfig to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ClusterReplicationConfig

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

ClusterReplicationConfig

ClusterReplicationConfig


decodeDelimited#

Static decodeDelimited(reader): ClusterReplicationConfig

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

ClusterReplicationConfig

ClusterReplicationConfig


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): ClusterReplicationConfig

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

ClusterReplicationConfig

ClusterReplicationConfig


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageClusterReplicationConfigClusterReplicationConfig
options?IConversionOptions-

Returns#

Object

Plain object