Class: DescribeNamespaceResponse

workflowservice.v1.DescribeNamespaceResponse

Represents a DescribeNamespaceResponse.

Implements

• IDescribeNamespaceResponse

Constructors

constructor

• new DescribeNamespaceResponse(properties?): DescribeNamespaceResponse

Constructs a new DescribeNamespaceResponse.

Parameters

Name	Type	Description
properties?	IDescribeNamespaceResponse	Properties to set

Returns

DescribeNamespaceResponse

Properties

config

• Optional config: null | INamespaceConfig

DescribeNamespaceResponse config.

Implementation of

IDescribeNamespaceResponse.config

---

failoverHistory

• failoverHistory: IFailoverStatus[]

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.

Implementation of

IDescribeNamespaceResponse.failoverHistory

---

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

▸ create(properties?): DescribeNamespaceResponse

Creates a new DescribeNamespaceResponse instance using the specified properties.

Parameters

Name	Type	Description
properties?	IDescribeNamespaceResponse	Properties to set

Returns

DescribeNamespaceResponse

DescribeNamespaceResponse instance

---

decode

▸ decode(reader, length?): DescribeNamespaceResponse

Decodes a DescribeNamespaceResponse message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

DescribeNamespaceResponse

DescribeNamespaceResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): DescribeNamespaceResponse

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

DescribeNamespaceResponse

DescribeNamespaceResponse

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

Parameters

Name	Type	Description
message	IDescribeNamespaceResponse	DescribeNamespaceResponse message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IDescribeNamespaceResponse	DescribeNamespaceResponse message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): DescribeNamespaceResponse

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

DescribeNamespaceResponse

DescribeNamespaceResponse

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeNamespaceResponse

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	DescribeNamespaceResponse	DescribeNamespaceResponse
options?	IConversionOptions	Conversion options

Returns

Object

Plain object