Class: NamespaceConfig

namespace.v1.NamespaceConfig

Represents a NamespaceConfig.

Implements

• INamespaceConfig

Constructors

constructor

• new NamespaceConfig(properties?): NamespaceConfig

Constructs a new NamespaceConfig.

Parameters

Name	Type	Description
properties?	INamespaceConfig	Properties to set

Returns

NamespaceConfig

Properties

badBinaries

• Optional badBinaries: null | IBadBinaries

NamespaceConfig badBinaries.

Implementation of

INamespaceConfig.badBinaries

---

customSearchAttributeAliases

• customSearchAttributeAliases: Object

Map from field name to alias.

Index signature

▪ [k: string]: string

Implementation of

INamespaceConfig.customSearchAttributeAliases

---

historyArchivalState

• historyArchivalState: ArchivalState

If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.

Implementation of

INamespaceConfig.historyArchivalState

---

historyArchivalUri

• historyArchivalUri: string

NamespaceConfig historyArchivalUri.

Implementation of

INamespaceConfig.historyArchivalUri

---

visibilityArchivalState

• visibilityArchivalState: ArchivalState

If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.

Implementation of

INamespaceConfig.visibilityArchivalState

---

visibilityArchivalUri

• visibilityArchivalUri: string

NamespaceConfig visibilityArchivalUri.

Implementation of

INamespaceConfig.visibilityArchivalUri

---

workflowExecutionRetentionTtl

• Optional workflowExecutionRetentionTtl: null | IDuration

NamespaceConfig workflowExecutionRetentionTtl.

Implementation of

INamespaceConfig.workflowExecutionRetentionTtl

Methods

toJSON

▸ toJSON(): Object

Converts this NamespaceConfig to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): NamespaceConfig

Creates a new NamespaceConfig instance using the specified properties.

Parameters

Name	Type	Description
properties?	INamespaceConfig	Properties to set

Returns

NamespaceConfig

NamespaceConfig instance

---

decode

▸ decode(reader, length?): NamespaceConfig

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

NamespaceConfig

NamespaceConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): NamespaceConfig

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

NamespaceConfig

NamespaceConfig

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

Parameters

Name	Type	Description
message	INamespaceConfig	NamespaceConfig message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	INamespaceConfig	NamespaceConfig message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): NamespaceConfig

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

NamespaceConfig

NamespaceConfig

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for NamespaceConfig

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 NamespaceConfig message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	NamespaceConfig	NamespaceConfig
options?	IConversionOptions	Conversion options

Returns

Object

Plain object