Class: FailoverNamespaceRegionRequest
cloudservice.v1.FailoverNamespaceRegionRequest
Represents a FailoverNamespaceRegionRequest.
Implements
Constructors
constructor
• new FailoverNamespaceRegionRequest(properties?): FailoverNamespaceRegionRequest
Constructs a new FailoverNamespaceRegionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFailoverNamespaceRegionRequest | Properties to set |
Returns
FailoverNamespaceRegionRequest
Properties
asyncOperationId
• asyncOperationId: string
The id to use for this async operation - optional.
Implementation of
IFailoverNamespaceRegionRequest.asyncOperationId
namespace
• namespace: string
The namespace to failover.
Implementation of
IFailoverNamespaceRegionRequest.namespace
region
• region: string
The id of the region to failover to. Must be a region that the namespace is currently available in.
Implementation of
IFailoverNamespaceRegionRequest.region
Methods
toJSON
▸ toJSON(): Object
Converts this FailoverNamespaceRegionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): FailoverNamespaceRegionRequest
Creates a new FailoverNamespaceRegionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFailoverNamespaceRegionRequest | Properties to set |
Returns
FailoverNamespaceRegionRequest
FailoverNamespaceRegionRequest instance
decode
▸ decode(reader, length?): FailoverNamespaceRegionRequest
Decodes a FailoverNamespaceRegionRequest 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
FailoverNamespaceRegionRequest
FailoverNamespaceRegionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): FailoverNamespaceRegionRequest
Decodes a FailoverNamespaceRegionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
FailoverNamespaceRegionRequest
FailoverNamespaceRegionRequest
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 FailoverNamespaceRegionRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.FailoverNamespaceRegionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFailoverNamespaceRegionRequest | FailoverNamespaceRegionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified FailoverNamespaceRegionRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.FailoverNamespaceRegionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFailoverNamespaceRegionRequest | FailoverNamespaceRegionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): FailoverNamespaceRegionRequest
Creates a FailoverNamespaceRegionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
FailoverNamespaceRegionRequest
FailoverNamespaceRegionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for FailoverNamespaceRegionRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a FailoverNamespaceRegionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | FailoverNamespaceRegionRequest | FailoverNamespaceRegionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object