Skip to main content

Class: DescribeNamespaceResponse

Represents a DescribeNamespaceResponse.

Properties​

config?​

optional config?: $Properties | null

DescribeNamespaceResponse config.

failoverHistory​

failoverHistory: $Properties[]

Contains the historical state of failover_versions for the cluster, truncated to contain only the last N states to ensure that the list does not grow unbounded.

failoverVersion​

failoverVersion: Long

DescribeNamespaceResponse failoverVersion.

isGlobalNamespace​

isGlobalNamespace: boolean

DescribeNamespaceResponse isGlobalNamespace.

namespaceInfo?​

optional namespaceInfo?: $Properties | null

DescribeNamespaceResponse namespaceInfo.

pollerGroupInfos​

pollerGroupInfos: $Properties[]

Deprecated. Use poller_groups_info instead, which carries a version so the client can ignore stale updates. The initial info that client should use for poller group assignment. This information is updated through poll response. Client is supposed to use the info received in the latest poll response.

pollerGroupsInfo?​

optional pollerGroupsInfo?: $Properties | null

The initial, versioned info that client should use for poller group assignment. This information is updated through poll responses. Client is supposed to use the info with the highest version it has received.

replicationConfig?​

optional replicationConfig?: $Properties | null

DescribeNamespaceResponse replicationConfig.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeNamespaceResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeNamespaceResponse & $Properties

Creates a new DescribeNamespaceResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeNamespaceResponse & $Properties

DescribeNamespaceResponse instance

Call Signature​

static create(properties?): DescribeNamespaceResponse

Creates a new DescribeNamespaceResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeNamespaceResponse

DescribeNamespaceResponse instance

decode()​

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

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

DescribeNamespaceResponse & $Properties

DescribeNamespaceResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeNamespaceResponse & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeNamespaceResponse & $Properties

DescribeNamespaceResponse

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

Parameters​

message​

$Properties

DescribeNamespaceResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeNamespaceResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeNamespaceResponse

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

Parameters​

object​

Plain object

Returns​

DescribeNamespaceResponse

DescribeNamespaceResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeNamespaceResponse

DescribeNamespaceResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object