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
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
AddNamespaceRegionRequest & $Properties
AddNamespaceRegionRequest instance
▸ create(properties?): AddNamespaceRegionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): AddNamespaceRegionRequest & $Properties
Decodes an AddNamespaceRegionRequest 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
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified AddNamespaceRegionRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.AddNamespaceRegionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | AddNamespaceRegionRequest message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | $Properties | AddNamespaceRegionRequest message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
AddNamespaceRegionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from an AddNamespaceRegionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | AddNamespaceRegionRequest | AddNamespaceRegionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object