Class: DescribeNamespaceResponse
workflowservice.v1.DescribeNamespaceResponse
Represents a DescribeNamespaceResponse.
Properties
config
• Optional config: null | $Properties
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: null | $Properties
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: null | $Properties
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: null | $Properties
DescribeNamespaceResponse replicationConfig.
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeNamespaceResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeNamespaceResponse & $Properties
Creates a new DescribeNamespaceResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DescribeNamespaceResponse & $Properties
DescribeNamespaceResponse instance
▸ create(properties?): DescribeNamespaceResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DescribeNamespaceResponse & $Properties
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 & $Properties
DescribeNamespaceResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeNamespaceResponse & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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