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?: $Properties | null

The status of namespace's capacity, if any.

---

connectivityRules

connectivityRules: $Properties[]

The connectivity rules that are set on this namespace.

---

createdTime?

optional createdTime?: $Properties | null

The date and time when the namespace was created.

---

endpoints?

optional endpoints?: $Properties | null

The endpoints for the namespace.

---

lastModifiedTime?

optional lastModifiedTime?: $Properties | null

The date and time when the namespace was last modified. Will not be set if the namespace has never been modified.

---

limits?

optional limits?: $Properties | null

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?: $Properties | null

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

Call Signature

static create(properties?): Namespace & $Shape

Creates a new Namespace instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

Namespace & $Shape

Namespace instance

Call Signature

static create(properties?): Namespace

Creates a new Namespace instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

Namespace

Namespace instance

---

decode()

static decode(reader, length?): Namespace & $Shape

Decodes a Namespace 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

Namespace & $Shape

Namespace

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): Namespace & $Shape

Decodes a Namespace message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

Namespace & $Shape

Namespace

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 Namespace message. Does not implicitly temporal.api.cloud.namespace.v1.Namespace.verify|verify messages.

Parameters

message

$Properties

Namespace message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

Namespace message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): Namespace

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

Parameters

object

{[k: string]: any; }

Plain object

Returns

Namespace

Namespace

---

toObject()

static toObject(message, options?): object

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

Parameters

message

Namespace

Namespace

options?

IConversionOptions

Conversion options

Returns

object

Plain object