Class: NamespaceFilter
Represents a NamespaceFilter.
Implements
Constructors
constructor
• new NamespaceFilter(properties?): NamespaceFilter
Constructs a new NamespaceFilter.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceFilter | Properties to set |
Returns
Properties
includeDeleted
• includeDeleted: boolean
By default namespaces in NAMESPACE_STATE_DELETED state are not included. Setting include_deleted to true will include deleted namespaces. Note: Namespace is in NAMESPACE_STATE_DELETED state when it was deleted from the system but associated data is not deleted yet.
Implementation of
INamespaceFilter.includeDeleted
Methods
toJSON
▸ toJSON(): Object
Converts this NamespaceFilter to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NamespaceFilter
Creates a new NamespaceFilter instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceFilter | Properties to set |
Returns
NamespaceFilter instance
decode
▸ decode(reader, length?): NamespaceFilter
Decodes a NamespaceFilter 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
NamespaceFilter
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NamespaceFilter
Decodes a NamespaceFilter message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NamespaceFilter
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 NamespaceFilter message. Does not implicitly temporal.api.namespace.v1.NamespaceFilter.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceFilter | NamespaceFilter message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NamespaceFilter message, length delimited. Does not implicitly temporal.api.namespace.v1.NamespaceFilter.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceFilter | NamespaceFilter message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NamespaceFilter
Creates a NamespaceFilter message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NamespaceFilter
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NamespaceFilter
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 NamespaceFilter message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NamespaceFilter | NamespaceFilter |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object