Class: NamespaceRegionStatus
namespace.v1.NamespaceRegionStatus
Represents a NamespaceRegionStatus.
Implements
Constructors
constructor
• new NamespaceRegionStatus(properties?): NamespaceRegionStatus
Constructs a new NamespaceRegionStatus.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceRegionStatus | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id of the async operation that is making changes to where the namespace is available, if any.
Implementation of
INamespaceRegionStatus.asyncOperationId
state
• state: string
The current state of the namespace region. Possible values: adding, active, passive, removing, failed. For any failed state, reach out to Temporal Cloud support for remediation.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this NamespaceRegionStatus to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NamespaceRegionStatus
Creates a new NamespaceRegionStatus instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceRegionStatus | Properties to set |
Returns
NamespaceRegionStatus instance
decode
▸ decode(reader, length?): NamespaceRegionStatus
Decodes a NamespaceRegionStatus 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
NamespaceRegionStatus
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NamespaceRegionStatus
Decodes a NamespaceRegionStatus message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NamespaceRegionStatus
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 NamespaceRegionStatus message. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceRegionStatus.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceRegionStatus | NamespaceRegionStatus message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NamespaceRegionStatus message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceRegionStatus.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceRegionStatus | NamespaceRegionStatus message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NamespaceRegionStatus
Creates a NamespaceRegionStatus message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NamespaceRegionStatus
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NamespaceRegionStatus
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 NamespaceRegionStatus message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NamespaceRegionStatus | NamespaceRegionStatus |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object