Class: UpdateNamespaceInfo
namespace.v1.UpdateNamespaceInfo
Represents an UpdateNamespaceInfo.
Implements
Constructors
constructor
• new UpdateNamespaceInfo(properties?): UpdateNamespaceInfo
Constructs a new UpdateNamespaceInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateNamespaceInfo | Properties to set |
Returns
Properties
data
• data: Object
A key-value map for any customized purpose. If data already exists on the namespace, this will merge with the existing key values.
Index signature
▪ [k: string]: string
Implementation of
description
• description: string
UpdateNamespaceInfo description.
Implementation of
IUpdateNamespaceInfo.description
ownerEmail
• ownerEmail: string
UpdateNamespaceInfo ownerEmail.
Implementation of
IUpdateNamespaceInfo.ownerEmail
state
• state: NamespaceState
New namespace state, server will reject if transition is not allowed. Allowed transitions are: Registered -> [ Deleted | Deprecated | Handover ] Handover -> [ Registered ] Default is NAMESPACE_STATE_UNSPECIFIED which is do not change state.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateNamespaceInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateNamespaceInfo
Creates a new UpdateNamespaceInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateNamespaceInfo | Properties to set |
Returns
UpdateNamespaceInfo instance
decode
▸ decode(reader, length?): UpdateNamespaceInfo
Decodes an UpdateNamespaceInfo 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
UpdateNamespaceInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateNamespaceInfo
Decodes an UpdateNamespaceInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateNamespaceInfo
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 UpdateNamespaceInfo message. Does not implicitly temporal.api.namespace.v1.UpdateNamespaceInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateNamespaceInfo | UpdateNamespaceInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateNamespaceInfo message, length delimited. Does not implicitly temporal.api.namespace.v1.UpdateNamespaceInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateNamespaceInfo | UpdateNamespaceInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateNamespaceInfo
Creates an UpdateNamespaceInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateNamespaceInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateNamespaceInfo
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 an UpdateNamespaceInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateNamespaceInfo | UpdateNamespaceInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object