Class: Replica
temporal:versioning:min_version=v0.13.0
Implements
Constructors
constructor
• new Replica(properties?): Replica
Constructs a new Replica.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IReplica | Properties to set |
Returns
Properties
id
• id: string
The id of the replica. This is generated by Temporal after a replica is created.
Implementation of
isPrimary
• isPrimary: boolean
Whether this replica is currently the primary one.
Implementation of
region
• region: string
The cloud provider and region of this replica.
Implementation of
state
• state: ReplicaState
The current state of this replica.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Replica to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Replica
Creates a new Replica instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IReplica | Properties to set |
Returns
Replica instance
decode
▸ decode(reader, length?): Replica
Decodes a Replica message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Replica
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Replica
Decodes a Replica message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Replica
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 Replica message. Does not implicitly temporal.api.cloud.namespace.v1.Replica.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IReplica | Replica message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Replica message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.Replica.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IReplica | Replica message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Replica
Creates a Replica message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Replica
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Replica
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Replica message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Replica | Replica |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object