Skip to main content

Class: UpdateNamespaceInfo

Represents an UpdateNamespaceInfo.

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


description​

description: string

UpdateNamespaceInfo description.


ownerEmail​

ownerEmail: string

UpdateNamespaceInfo 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.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateNamespaceInfo to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): UpdateNamespaceInfo & $Properties

Creates a new UpdateNamespaceInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateNamespaceInfo & $Properties

UpdateNamespaceInfo instance

Call Signature​

static create(properties?): UpdateNamespaceInfo

Creates a new UpdateNamespaceInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateNamespaceInfo

UpdateNamespaceInfo instance


decode()​

static decode(reader, length?): UpdateNamespaceInfo & $Properties

Decodes an UpdateNamespaceInfo message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

UpdateNamespaceInfo & $Properties

UpdateNamespaceInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): UpdateNamespaceInfo & $Properties

Decodes an UpdateNamespaceInfo message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateNamespaceInfo & $Properties

UpdateNamespaceInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


encode()​

static encode(message, writer?): Writer

Encodes the specified UpdateNamespaceInfo message. Does not implicitly temporal.api.namespace.v1.UpdateNamespaceInfo.verify|verify messages.

Parameters​

message​

$Properties

UpdateNamespaceInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified UpdateNamespaceInfo message, length delimited. Does not implicitly temporal.api.namespace.v1.UpdateNamespaceInfo.verify|verify messages.

Parameters​

message​

$Properties

UpdateNamespaceInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): UpdateNamespaceInfo

Creates an UpdateNamespaceInfo message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

UpdateNamespaceInfo

UpdateNamespaceInfo


toObject()​

static toObject(message, options?): object

Creates a plain object from an UpdateNamespaceInfo message. Also converts values to other types if specified.

Parameters​

message​

UpdateNamespaceInfo

UpdateNamespaceInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object