Skip to main content

Class: ClusterReplicationConfig

replication.v1.ClusterReplicationConfig

Represents a ClusterReplicationConfig.

Properties

clusterName

clusterName: string

ClusterReplicationConfig clusterName.

Methods

toJSON

toJSON(): Object

Converts this ClusterReplicationConfig to JSON.

Returns

Object

JSON object


create

create(properties?): ClusterReplicationConfig & $Properties

Creates a new ClusterReplicationConfig instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

ClusterReplicationConfig & $Properties

ClusterReplicationConfig instance

create(properties?): ClusterReplicationConfig

Parameters

NameType
properties?$Properties

Returns

ClusterReplicationConfig


decode

decode(reader, length?): ClusterReplicationConfig & $Properties

Decodes a ClusterReplicationConfig message from the specified reader or buffer.

Parameters

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

Returns

ClusterReplicationConfig & $Properties

ClusterReplicationConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ClusterReplicationConfig & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ClusterReplicationConfig & $Properties

ClusterReplicationConfig

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

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

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageClusterReplicationConfigClusterReplicationConfig
options?IConversionOptionsConversion options

Returns

Object

Plain object