Class: NamespaceSpec

Represents a NamespaceSpec.

Properties

apiKeyAuth?

optional apiKeyAuth?: $Properties | null

The API key auth configuration for the namespace. If unspecified, API keys will be disabled. temporal:versioning:min_version=v0.2.0

---

capacitySpec?

optional capacitySpec?: $Properties | null

The capacity configuration for the namespace. There are two capacity modes: on-demand and provisioned. On-demand capacity mode allows the namespace to scale automatically based on usage. Provisioned capacity mode allows the user to specify a fixed amount of capacity (in TRUs) for the namespace. Can be changed only when the last capacity request is not in progress. temporal:versioning:min_version=v0.10.0

---

codecServer?

optional codecServer?: $Properties | null

Codec server spec used by UI to decode payloads for all users interacting with this namespace. Optional, default is unset.

---

connectivityRuleIds

connectivityRuleIds: string[]

The private connectivity configuration for the namespace. This will apply the connectivity rules specified to the namespace. temporal:versioning:min_version=v0.6.0

---

customSearchAttributes

customSearchAttributes: object

The custom search attributes to use for the namespace. The name of the attribute is the key and the type is the value. Supported attribute types: text, keyword, int, double, bool, datetime, keyword_list. NOTE: currently deleting a search attribute is not supported. Optional, default is empty. Deprecated: Not supported after v0.3.0 api version. Use search_attributes instead. temporal:versioning:max_version=v0.3.0

Index Signature

[k: string]: string

---

fairness?

optional fairness?: $Properties | null

The fairness configuration for the namespace. If unspecified, fairness features will be disabled. temporal:versioning:min_version=v0.14.0

---

highAvailability?

optional highAvailability?: $Properties | null

The high availability configuration for the namespace. temporal:versioning:min_version=v0.4.0

---

lifecycle?

optional lifecycle?: $Properties | null

The lifecycle configuration for the namespace. temporal:versioning:min_version=v0.4.0

---

mtlsAuth?

optional mtlsAuth?: $Properties | null

The mTLS auth configuration for the namespace. If unspecified, mTLS will be disabled.

---

name

name: string

The name to use for the namespace. This will create a namespace that's available at '..tmprl.cloud:7233'. The name is immutable. Once set, it cannot be changed.

---

regions

regions: string[]

The ids of the regions where the namespace should be available. The GetRegions API can be used to get the list of valid region ids. Specifying more than one region makes the namespace "global", which is currently a preview only feature with restricted access. Please reach out to Temporal support for more information on global namespaces. When provisioned the global namespace will be active on the first region in the list and passive on the rest. Number of supported regions is 2. The regions is immutable. Once set, it cannot be changed. Example: ["aws-us-west-2"]. Deprecated: Use replicas field instead. temporal:versioning:max_version=v0.15.0

---

replicas

replicas: $Properties[]

The replication configuration for the namespace. At least one replica must be specified. Only one replica can be marked to be the desired active one. The status of each replica is available in the Namespace.replicas field. Use HighAvailabilitySpec to set the preferred primary replica ID. If the preferred primary replica ID is not set, the first replica in this replicas list will be the preferred primary. temporal:versioning:min_version=v0.13.0

---

retentionDays

retentionDays: number

The number of days the workflows data will be retained for. Changes to the retention period may impact your storage costs. Any changes to the retention period will be applied to all new running workflows.

---

searchAttributes

searchAttributes: object

The custom search attributes to use for the namespace. The name of the attribute is the key and the type is the value. Note: currently deleting a search attribute is not supported. Optional, default is empty. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=custom_search_attributes

Index Signature

[k: string]: SearchAttributeType

Methods

toJSON()

toJSON(): object

Converts this NamespaceSpec to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): NamespaceSpec & $Shape

Creates a new NamespaceSpec instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

NamespaceSpec & $Shape

NamespaceSpec instance

Call Signature

static create(properties?): NamespaceSpec

Creates a new NamespaceSpec instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

NamespaceSpec

NamespaceSpec instance

---

decode()

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

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

NamespaceSpec & $Shape

NamespaceSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): NamespaceSpec & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

NamespaceSpec & $Shape

NamespaceSpec

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

Parameters

message

$Properties

NamespaceSpec message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

NamespaceSpec message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): NamespaceSpec

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

Parameters

object

{[k: string]: any; }

Plain object

Returns

NamespaceSpec

NamespaceSpec

---

toObject()

static toObject(message, options?): object

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

Parameters

message

NamespaceSpec

NamespaceSpec

options?

IConversionOptions

Conversion options

Returns

object

Plain object