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
▸ create(properties?): ReplicaSpec & $Properties
Creates a new ReplicaSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ReplicaSpec instance
▸ create(properties?): ReplicaSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ReplicaSpec & $Properties
Decodes a ReplicaSpec 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
ReplicaSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ReplicaSpec & $Properties
Decodes a ReplicaSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ReplicaSpec
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 ReplicaSpec message. Does not implicitly temporal.api.cloud.namespace.v1.ReplicaSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ReplicaSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ReplicaSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.ReplicaSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ReplicaSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ReplicaSpec
Creates a ReplicaSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ReplicaSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ReplicaSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ReplicaSpec | ReplicaSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object