Skip to main content

Class: ClusterReplicationConfig

Represents a ClusterReplicationConfig.

Properties​

clusterName​

clusterName: string

ClusterReplicationConfig clusterName.

replicationRampDuration?​

optional replicationRampDuration?: $Properties | null

Ramp duration when this cluster is added as passive by UpdateNamespace; unset or non-positive disables gradual connect. This field is not persisted and is omitted from namespace responses.

Methods​

toJSON()​

toJSON(): object

Converts this ClusterReplicationConfig to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ClusterReplicationConfig & $Properties

Creates a new ClusterReplicationConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ClusterReplicationConfig & $Properties

ClusterReplicationConfig instance

Call Signature​

static create(properties?): ClusterReplicationConfig

Creates a new ClusterReplicationConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ClusterReplicationConfig

ClusterReplicationConfig instance

decode()​

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

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

ClusterReplicationConfig & $Properties

ClusterReplicationConfig

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ClusterReplicationConfig & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader 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()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

ClusterReplicationConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ClusterReplicationConfig message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

Plain 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​

message​

ClusterReplicationConfig

ClusterReplicationConfig

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object