Class: Region

region.v1.Region

Represents a Region.

Implements

• IRegion

Constructors

constructor

• new Region(properties?): Region

Constructs a new Region.

Parameters

Name	Type	Description
properties?	IRegion	Properties to set

Returns

Region

Properties

cloudProvider

• cloudProvider: string

The name of the cloud provider that's hosting the region. Currently only "aws" is supported.

Implementation of

IRegion.cloudProvider

---

cloudProviderRegion

• cloudProviderRegion: string

The region identifier as defined by the cloud provider.

Implementation of

IRegion.cloudProviderRegion

---

id

• id: string

The id of the temporal cloud region.

Implementation of

IRegion.id

---

location

• location: string

The human readable location of the region.

Implementation of

IRegion.location

Methods

toJSON

▸ toJSON(): Object

Converts this Region to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Region

Creates a new Region instance using the specified properties.

Parameters

Name	Type	Description
properties?	IRegion	Properties to set

Returns

Region

Region instance

---

decode

▸ decode(reader, length?): Region

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

Region

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Region

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

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	IRegion	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	IRegion	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

Region

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Region

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 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