Skip to main content

Class: AddNamespaceRegionRequest

cloudservice.v1.AddNamespaceRegionRequest

Represents an AddNamespaceRegionRequest.

Properties​

asyncOperationId​

• asyncOperationId: string

The id to use for this async operation - optional.


namespace​

• namespace: string

The namespace to add the region to.


region​

• region: string

The id of the standby region to add to the namespace. The GetRegions API can be used to get the list of valid region ids. Example: "aws-us-west-2".


resourceVersion​

• resourceVersion: string

The version of the namespace for which this add region operation is intended for. The latest version can be found in the GetNamespace operation response.

Methods​

toJSON​

▸ toJSON(): Object

Converts this AddNamespaceRegionRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): AddNamespaceRegionRequest & $Properties

Creates a new AddNamespaceRegionRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

AddNamespaceRegionRequest & $Properties

AddNamespaceRegionRequest instance

▸ create(properties?): AddNamespaceRegionRequest

Parameters​

NameType
properties?$Properties

Returns​

AddNamespaceRegionRequest


decode​

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

Decodes an AddNamespaceRegionRequest message from the specified reader or buffer.

Parameters​

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

Returns​

AddNamespaceRegionRequest & $Properties

AddNamespaceRegionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): AddNamespaceRegionRequest & $Properties

Decodes an AddNamespaceRegionRequest message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

AddNamespaceRegionRequest & $Properties

AddNamespaceRegionRequest

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): AddNamespaceRegionRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

AddNamespaceRegionRequest

AddNamespaceRegionRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageAddNamespaceRegionRequestAddNamespaceRegionRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object