Skip to main content

Class: Replica

temporal:versioning:min_version=v0.13.0

Properties​

id​

id: string

The id of the replica. This is generated by Temporal after a replica is created.

isPrimary​

isPrimary: boolean

Whether this replica is currently the primary one.

region​

region: string

The cloud provider and region of this replica.

state​

state: ReplicaState

The current state of this replica.

Methods​

toJSON()​

toJSON(): object

Converts this Replica to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Replica & $Properties

Creates a new Replica instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Replica & $Properties

Replica instance

Call Signature​

static create(properties?): Replica

Creates a new Replica instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Replica

Replica instance

decode()​

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

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

Replica & $Properties

Replica

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Replica & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Replica & $Properties

Replica

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

Parameters​

message​

$Properties

Replica message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Replica message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Replica

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Replica

Replica

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Replica

Replica

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object