Skip to main content

Class: DescribeNamespaceResponse

workflowservice.v1.DescribeNamespaceResponse

Represents a DescribeNamespaceResponse.

Implements#

Constructors#

constructor#

new DescribeNamespaceResponse(properties?)

Constructs a new DescribeNamespaceResponse.

Parameters#

NameType
properties?IDescribeNamespaceResponse

Properties#

config#

Optional config: null | INamespaceConfig

DescribeNamespaceResponse config.

Implementation of#

IDescribeNamespaceResponse.config


failoverVersion#

failoverVersion: Long

DescribeNamespaceResponse failoverVersion.

Implementation of#

IDescribeNamespaceResponse.failoverVersion


isGlobalNamespace#

isGlobalNamespace: boolean

DescribeNamespaceResponse isGlobalNamespace.

Implementation of#

IDescribeNamespaceResponse.isGlobalNamespace


namespaceInfo#

Optional namespaceInfo: null | INamespaceInfo

DescribeNamespaceResponse namespaceInfo.

Implementation of#

IDescribeNamespaceResponse.namespaceInfo


replicationConfig#

Optional replicationConfig: null | INamespaceReplicationConfig

DescribeNamespaceResponse replicationConfig.

Implementation of#

IDescribeNamespaceResponse.replicationConfig

Methods#

toJSON#

toJSON(): Object

Converts this DescribeNamespaceResponse to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): DescribeNamespaceResponse

Decodes a DescribeNamespaceResponse message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

DescribeNamespaceResponse

DescribeNamespaceResponse


decodeDelimited#

Static decodeDelimited(reader): DescribeNamespaceResponse

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

DescribeNamespaceResponse

DescribeNamespaceResponse


encode#

Static encode(message, writer?): Writer

Encodes the specified DescribeNamespaceResponse message. Does not implicitly {@link temporal.api.workflowservice.v1.DescribeNamespaceResponse.verify|verify} messages.

Parameters#

NameTypeDescription
messageIDescribeNamespaceResponseDescribeNamespaceResponse message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIDescribeNamespaceResponseDescribeNamespaceResponse message or plain object to encode
writer?Writer-

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageDescribeNamespaceResponseDescribeNamespaceResponse
options?IConversionOptions-

Returns#

Object

Plain object