Skip to main content

Class: DescribeNamespaceResponse

workflowservice.v1.DescribeNamespaceResponse

Represents a DescribeNamespaceResponse.

Implements

Constructors

constructor

new DescribeNamespaceResponse(properties?)

Constructs a new DescribeNamespaceResponse.

Parameters

NameTypeDescription
properties?IDescribeNamespaceResponseProperties to set

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


create

Static create(properties?): DescribeNamespaceResponse

Creates a new DescribeNamespaceResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeNamespaceResponseProperties to set

Returns

DescribeNamespaceResponse

DescribeNamespaceResponse instance


decode

Static decode(reader, length?): DescribeNamespaceResponse

Decodes a DescribeNamespaceResponse message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

DescribeNamespaceResponse

DescribeNamespaceResponse


decodeDelimited

Static decodeDelimited(reader): DescribeNamespaceResponse

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

Throws

If the payload is not a reader or valid buffer

Throws

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

Parameters

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

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

NameTypeDescription
objectObjectPlain object

Returns

DescribeNamespaceResponse

DescribeNamespaceResponse


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeNamespaceResponse

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object