Class: NamespaceInfo
Represents a NamespaceInfo.
Implements
Constructors
constructor
• new NamespaceInfo(properties?): NamespaceInfo
Constructs a new NamespaceInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceInfo | Properties to set |
Returns
Properties
capabilities
• Optional capabilities: null | ICapabilities
All capabilities the namespace supports.
Implementation of
data
• data: Object
A key-value map for any customized purpose.
Index signature
▪ [k: string]: string
Implementation of
description
• description: string
NamespaceInfo description.
Implementation of
id
• id: string
NamespaceInfo id.
Implementation of
limits
• Optional limits: null | ILimits
Namespace configured limits
Implementation of
name
• name: string
NamespaceInfo name.
Implementation of
ownerEmail
• ownerEmail: string
NamespaceInfo ownerEmail.
Implementation of
state
• state: NamespaceState
NamespaceInfo state.
Implementation of
supportsSchedules
• supportsSchedules: boolean
Whether scheduled workflows are supported on this namespace. This is only needed temporarily while the feature is experimental, so we can give it a high tag.
Implementation of
INamespaceInfo.supportsSchedules
Methods
toJSON
▸ toJSON(): Object
Converts this NamespaceInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NamespaceInfo
Creates a new NamespaceInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespaceInfo | Properties to set |
Returns
NamespaceInfo instance
decode
▸ decode(reader, length?): NamespaceInfo
Decodes a NamespaceInfo 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
NamespaceInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NamespaceInfo
Decodes a NamespaceInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NamespaceInfo
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 NamespaceInfo message. Does not implicitly temporal.api.namespace.v1.NamespaceInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceInfo | NamespaceInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NamespaceInfo message, length delimited. Does not implicitly temporal.api.namespace.v1.NamespaceInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespaceInfo | NamespaceInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NamespaceInfo
Creates a NamespaceInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NamespaceInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NamespaceInfo
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 NamespaceInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NamespaceInfo | NamespaceInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object