Skip to main content

Class: NamespaceConfig

Represents a NamespaceConfig.

Properties​

badBinaries?​

optional badBinaries?: $Properties | null

NamespaceConfig badBinaries.

customSearchAttributeAliases​

customSearchAttributeAliases: object

Map from field name to alias.

Index Signature​

[k: string]: string

historyArchivalState​

historyArchivalState: ArchivalState

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

historyArchivalUri​

historyArchivalUri: string

NamespaceConfig historyArchivalUri.

visibilityArchivalState​

visibilityArchivalState: ArchivalState

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

visibilityArchivalUri​

visibilityArchivalUri: string

NamespaceConfig visibilityArchivalUri.

workflowExecutionRetentionTtl?​

optional workflowExecutionRetentionTtl?: $Properties | null

NamespaceConfig workflowExecutionRetentionTtl.

Methods​

toJSON()​

toJSON(): object

Converts this NamespaceConfig to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NamespaceConfig & $Properties

Creates a new NamespaceConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NamespaceConfig & $Properties

NamespaceConfig instance

Call Signature​

static create(properties?): NamespaceConfig

Creates a new NamespaceConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NamespaceConfig

NamespaceConfig instance

decode()​

static decode(reader, length?): NamespaceConfig & $Properties

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

NamespaceConfig & $Properties

NamespaceConfig

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NamespaceConfig & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NamespaceConfig & $Properties

NamespaceConfig

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

Parameters​

message​

$Properties

NamespaceConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NamespaceConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NamespaceConfig

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

Parameters​

object​

Plain object

Returns​

NamespaceConfig

NamespaceConfig

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NamespaceConfig

NamespaceConfig

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object