Class: DescribeNamespaceRequest
workflowservice.v1.DescribeNamespaceRequest
Represents a DescribeNamespaceRequest.
Properties
id
• id: string
DescribeNamespaceRequest id.
namespace
• namespace: string
DescribeNamespaceRequest namespace.
weakConsistency
• weakConsistency: boolean
If true, the server may serve the response from an eventually-consistent source instead of reading through to persistence. Defaults to false, which preserves read-after-write consistency. SDKs should set this when fetching namespace capabilities on worker/client startup.
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeNamespaceRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeNamespaceRequest & $Properties
Creates a new DescribeNamespaceRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DescribeNamespaceRequest & $Properties
DescribeNamespaceRequest instance
▸ create(properties?): DescribeNamespaceRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DescribeNamespaceRequest & $Properties
Decodes a DescribeNamespaceRequest 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
DescribeNamespaceRequest & $Properties
DescribeNamespaceRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeNamespaceRequest & $Properties
Decodes a DescribeNamespaceRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeNamespaceRequest & $Properties
DescribeNamespaceRequest
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 DescribeNamespaceRequest message. Does not implicitly temporal.api.workflowservice.v1.DescribeNamespaceRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeNamespaceRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeNamespaceRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeNamespaceRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeNamespaceRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeNamespaceRequest
Creates a DescribeNamespaceRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeNamespaceRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeNamespaceRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeNamespaceRequest | DescribeNamespaceRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object