Class: DescribeNamespaceRequest
workflowservice.v1.DescribeNamespaceRequest
Represents a DescribeNamespaceRequest.
Implements
Constructors
constructor
• new DescribeNamespaceRequest(properties?): DescribeNamespaceRequest
Constructs a new DescribeNamespaceRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeNamespaceRequest | Properties to set |
Returns
Properties
id
• id: string
DescribeNamespaceRequest id.
Implementation of
namespace
• namespace: string
DescribeNamespaceRequest namespace.
Implementation of
IDescribeNamespaceRequest.namespace
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeNamespaceRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeNamespaceRequest
Creates a new DescribeNamespaceRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeNamespaceRequest | Properties to set |
Returns
DescribeNamespaceRequest instance
decode
▸ decode(reader, length?): DescribeNamespaceRequest
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeNamespaceRequest
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
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 | IDescribeNamespaceRequest | 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 | IDescribeNamespaceRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DescribeNamespaceRequest
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 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