Skip to main content

Class: GetRegionRequest

cloudservice.v1.GetRegionRequest

Represents a GetRegionRequest.

Properties

region

region: string

The id of the region to get.

Methods

toJSON

toJSON(): Object

Converts this GetRegionRequest to JSON.

Returns

Object

JSON object


create

create(properties?): GetRegionRequest & $Properties

Creates a new GetRegionRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

GetRegionRequest & $Properties

GetRegionRequest instance

create(properties?): GetRegionRequest

Parameters

NameType
properties?$Properties

Returns

GetRegionRequest


decode

decode(reader, length?): GetRegionRequest & $Properties

Decodes a GetRegionRequest message from the specified reader or buffer.

Parameters

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

Returns

GetRegionRequest & $Properties

GetRegionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): GetRegionRequest & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

GetRegionRequest & $Properties

GetRegionRequest

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): GetRegionRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

GetRegionRequest

GetRegionRequest


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageGetRegionRequestGetRegionRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object