Skip to main content

Class: 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()​

Call Signature​

static create(properties?): AddNamespaceRegionRequest & $Properties

Creates a new AddNamespaceRegionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AddNamespaceRegionRequest & $Properties

AddNamespaceRegionRequest instance

Call Signature​

static create(properties?): AddNamespaceRegionRequest

Creates a new AddNamespaceRegionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AddNamespaceRegionRequest

AddNamespaceRegionRequest instance


decode()​

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

Decodes an AddNamespaceRegionRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message 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()​

static decodeDelimited(reader): AddNamespaceRegionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader 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()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

AddNamespaceRegionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

AddNamespaceRegionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): AddNamespaceRegionRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

AddNamespaceRegionRequest

AddNamespaceRegionRequest


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

AddNamespaceRegionRequest

AddNamespaceRegionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object