Class: Region
Represents a Region.
Properties
cloudProvider
• cloudProvider: CloudProvider
The cloud provider that's hosting the region. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=cloud_provider_deprecated
cloudProviderDeprecated
• cloudProviderDeprecated: string
The name of the cloud provider that's hosting the region. Currently only "aws" is supported. Deprecated: Not supported after v0.3.0 api version. Use cloud_provider instead. temporal:versioning:max_version=v0.3.0
cloudProviderRegion
• cloudProviderRegion: string
The region identifier as defined by the cloud provider.
id
• id: string
The id of the temporal cloud region.
location
• location: string
The human readable location of the region.
Methods
toJSON
▸ toJSON(): Object
Converts this Region to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Region & $Properties
Creates a new Region instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Region instance
▸ create(properties?): Region
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Region & $Properties
Decodes a Region 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
Region
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Region & $Properties
Decodes a Region message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Region
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 Region message. Does not implicitly temporal.api.cloud.region.v1.Region.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Region message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Region message, length delimited. Does not implicitly temporal.api.cloud.region.v1.Region.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Region message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Region
Creates a Region message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Region
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Region message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Region | Region |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object