Skip to main content

Class: ReplicaSpec

temporal:versioning:min_version=v0.13.0

Properties​

region​

region: string

The id of the region where the replica should be placed. The GetRegions API can be used to get the list of valid region ids. All the replicas must adhere to the region's max_in_region_replicas limit and connectable_region_ids. Required. Immutable. Example: "aws-us-west-2".

Methods​

toJSON()​

toJSON(): object

Converts this ReplicaSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ReplicaSpec & $Properties

Creates a new ReplicaSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ReplicaSpec & $Properties

ReplicaSpec instance

Call Signature​

static create(properties?): ReplicaSpec

Creates a new ReplicaSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ReplicaSpec

ReplicaSpec instance

decode()​

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

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

ReplicaSpec & $Properties

ReplicaSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ReplicaSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ReplicaSpec & $Properties

ReplicaSpec

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 ReplicaSpec message. Does not implicitly temporal.api.cloud.namespace.v1.ReplicaSpec.verify|verify messages.

Parameters​

message​

$Properties

ReplicaSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ReplicaSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.ReplicaSpec.verify|verify messages.

Parameters​

message​

$Properties

ReplicaSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ReplicaSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ReplicaSpec

ReplicaSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ReplicaSpec

ReplicaSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object