Class: NamespaceSpec
Represents a NamespaceSpec.
Implements
Constructors
constructor
• new NamespaceSpec(properties?): NamespaceSpec
Constructs a new NamespaceSpec.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceSpec | Properties to set |
Returns
Properties
apiKeyAuth
• Optional apiKeyAuth: null | IApiKeyAuthSpec
The API key auth configuration for the namespace. If unspecified, API keys will be disabled. temporal:versioning:min_version=2024-05-13-00
Implementation of
codecServer
• Optional codecServer: null | ICodecServerSpec
Codec server spec used by UI to decode payloads for all users interacting with this namespace. Optional, default is unset.
Implementation of
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.
Index signature
▪ [k: string]: string
Implementation of
INamespaceSpec.customSearchAttributes
mtlsAuth
• Optional mtlsAuth: null | IMtlsAuthSpec
The mTLS auth configuration for the namespace. If unspecified, mTLS will be disabled.
Implementation of
name
• name: string
The name to use for the namespace.
This will create a namespace that's available at '
Implementation of
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"].
Implementation of
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.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this NamespaceSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NamespaceSpec
Creates a new NamespaceSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceSpec | Properties to set |
Returns
NamespaceSpec instance
decode
▸ decode(reader, length?): NamespaceSpec
Decodes a NamespaceSpec 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
NamespaceSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NamespaceSpec
Decodes a NamespaceSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NamespaceSpec
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 NamespaceSpec message. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceSpec | NamespaceSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NamespaceSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceSpec | NamespaceSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NamespaceSpec
Creates a NamespaceSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NamespaceSpec
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NamespaceSpec
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 NamespaceSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NamespaceSpec | NamespaceSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object