Class: Namespace
Represents a Namespace.
Properties
activeRegion
• activeRegion: string
The currently active region for the namespace.
asyncOperationId
• asyncOperationId: string
The id of the async operation that is creating/updating/deleting the namespace, if any.
capacity
• Optional capacity: null | $Properties
The status of namespace's capacity, if any.
connectivityRules
• connectivityRules: $Properties[]
The connectivity rules that are set on this namespace.
createdTime
• Optional createdTime: null | $Properties
The date and time when the namespace was created.
endpoints
• Optional endpoints: null | $Properties
The endpoints for the namespace.
lastModifiedTime
• Optional lastModifiedTime: null | $Properties
The date and time when the namespace was last modified. Will not be set if the namespace has never been modified.
limits
• Optional limits: null | $Properties
The limits set on the namespace currently.
namespace
• namespace: string
The namespace identifier.
privateConnectivities
• privateConnectivities: $Properties[]
The private connectivities for the namespace, if any.
regionStatus
• regionStatus: Object
The status of each region where the namespace is available. The id of the region is the key and the status is the value of the map. deprecated: Use replicas field instead. temporal:versioning:max_version=v0.15.0
Index signature
▪ [k: string]: $Properties
replicas
• replicas: $Properties[]
The status of each replica where the namespace is available. temporal:versioning:min_version=v0.13.0
resourceVersion
• resourceVersion: string
The current version of the namespace specification. The next update operation will have to include this version.
spec
• Optional spec: null | $Properties
The namespace specification.
state
• state: ResourceState
The current state of the namespace. For any failed state, reach out to Temporal Cloud support for remediation. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated
stateDeprecated
• stateDeprecated: string
The current state of the namespace. Deprecated: Not supported after v0.3.0 api version. Use state instead. temporal:versioning:max_version=v0.3.0
tags
• tags: Object
The tags for the namespace.
Index signature
▪ [k: string]: string
Methods
toJSON
▸ toJSON(): Object
Converts this Namespace to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Namespace & $Shape
Creates a new Namespace instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Namespace instance
▸ create(properties?): Namespace
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Namespace & $Shape
Decodes a Namespace 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
Namespace
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Namespace & $Shape
Decodes a Namespace message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Namespace
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 Namespace message. Does not implicitly temporal.api.cloud.namespace.v1.Namespace.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Namespace message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Namespace message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.Namespace.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Namespace message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Namespace
Creates a Namespace message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Namespace
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Namespace message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Namespace | Namespace |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object