Skip to main content

Class: GetRegionsResponse

cloudservice.v1.GetRegionsResponse

Represents a GetRegionsResponse.

Properties​

regions​

• regions: $Properties[]

The temporal cloud regions.

Methods​

toJSON​

▸ toJSON(): Object

Converts this GetRegionsResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): GetRegionsResponse & $Properties

Creates a new GetRegionsResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

GetRegionsResponse & $Properties

GetRegionsResponse instance

▸ create(properties?): GetRegionsResponse

Parameters​

NameType
properties?$Properties

Returns​

GetRegionsResponse


decode​

▸ decode(reader, length?): GetRegionsResponse & $Properties

Decodes a GetRegionsResponse message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

GetRegionsResponse & $Properties

GetRegionsResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): GetRegionsResponse & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

GetRegionsResponse & $Properties

GetRegionsResponse

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

Parameters​

NameTypeDescription
message$PropertiesGetRegionsResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesGetRegionsResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): GetRegionsResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

GetRegionsResponse

GetRegionsResponse


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageGetRegionsResponseGetRegionsResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object