Class: NamespaceInfo

Represents a NamespaceInfo.

Properties

capabilities?

optional capabilities?: $Properties | null

All capabilities the namespace supports.

---

data

data: object

A key-value map for any customized purpose.

Index Signature

[k: string]: string

---

description

description: string

NamespaceInfo description.

---

id

id: string

NamespaceInfo id.

---

limits?

optional limits?: $Properties | null

Namespace configured limits

---

name

name: string

NamespaceInfo name.

---

ownerEmail

ownerEmail: string

NamespaceInfo ownerEmail.

---

state

state: NamespaceState

NamespaceInfo state.

---

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.

Methods

toJSON()

toJSON(): object

Converts this NamespaceInfo to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): NamespaceInfo & $Properties

Creates a new NamespaceInfo instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

NamespaceInfo & $Properties

NamespaceInfo instance

Call Signature

static create(properties?): NamespaceInfo

Creates a new NamespaceInfo instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

NamespaceInfo

NamespaceInfo instance

---

decode()

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

Decodes a NamespaceInfo 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

NamespaceInfo & $Properties

NamespaceInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): NamespaceInfo & $Properties

Decodes a NamespaceInfo message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

NamespaceInfo & $Properties

NamespaceInfo

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 NamespaceInfo message. Does not implicitly temporal.api.namespace.v1.NamespaceInfo.verify|verify messages.

Parameters

message

$Properties

NamespaceInfo message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

NamespaceInfo message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): NamespaceInfo

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

Parameters

object

{[k: string]: any; }

Plain object

Returns

NamespaceInfo

NamespaceInfo

---

toObject()

static toObject(message, options?): object

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

Parameters

message

NamespaceInfo

NamespaceInfo

options?

IConversionOptions

Conversion options

Returns

object

Plain object