Skip to main content

Class: NamespaceFilter

Represents a NamespaceFilter.

Properties​

includeDeleted​

includeDeleted: boolean

By default namespaces in NAMESPACE_STATE_DELETED state are not included. Setting include_deleted to true will include deleted namespaces. Note: Namespace is in NAMESPACE_STATE_DELETED state when it was deleted from the system but associated data is not deleted yet.

Methods​

toJSON()​

toJSON(): object

Converts this NamespaceFilter to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NamespaceFilter & $Properties

Creates a new NamespaceFilter instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NamespaceFilter & $Properties

NamespaceFilter instance

Call Signature​

static create(properties?): NamespaceFilter

Creates a new NamespaceFilter instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NamespaceFilter

NamespaceFilter instance

decode()​

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

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

NamespaceFilter & $Properties

NamespaceFilter

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NamespaceFilter & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NamespaceFilter & $Properties

NamespaceFilter

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

Parameters​

message​

$Properties

NamespaceFilter message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NamespaceFilter message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NamespaceFilter

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

NamespaceFilter

NamespaceFilter

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NamespaceFilter

NamespaceFilter

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object