Skip to main content

Class: NamespaceConfig

namespace.v1.NamespaceConfig

Represents a NamespaceConfig.

Properties

badBinaries

Optional badBinaries: null | $Properties

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

NamespaceConfig workflowExecutionRetentionTtl.

Methods

toJSON

toJSON(): Object

Converts this NamespaceConfig to JSON.

Returns

Object

JSON object


create

create(properties?): NamespaceConfig & $Properties

Creates a new NamespaceConfig instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

NamespaceConfig & $Properties

NamespaceConfig instance

create(properties?): NamespaceConfig

Parameters

NameType
properties?$Properties

Returns

NamespaceConfig


decode

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

Decodes a NamespaceConfig message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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

decodeDelimited(reader): NamespaceConfig & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader 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

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesNamespaceConfig message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
message$PropertiesNamespaceConfig message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

NamespaceConfig

NamespaceConfig


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageNamespaceConfigNamespaceConfig
options?IConversionOptionsConversion options

Returns

Object

Plain object