Class: Namespace

namespace.v1.Namespace

Represents a Namespace.

Implements

• INamespace

Constructors

constructor

• new Namespace(properties?): Namespace

Constructs a new Namespace.

Parameters

Name	Type	Description
properties?	INamespace	Properties to set

Returns

Namespace

Properties

activeRegion

• activeRegion: string

The currently active region for the namespace.

Implementation of

INamespace.activeRegion

---

asyncOperationId

• asyncOperationId: string

The id of the async operation that is creating/updating/deleting the namespace, if any.

Implementation of

INamespace.asyncOperationId

---

createdTime

• Optional createdTime: null | ITimestamp

The date and time when the namespace was created.

Implementation of

INamespace.createdTime

---

endpoints

• Optional endpoints: null | IEndpoints

The endpoints for the namespace.

Implementation of

INamespace.endpoints

---

lastModifiedTime

• Optional lastModifiedTime: null | ITimestamp

The date and time when the namespace was last modified. Will not be set if the namespace has never been modified.

Implementation of

INamespace.lastModifiedTime

---

limits

• Optional limits: null | ILimits

The limits set on the namespace currently.

Implementation of

INamespace.limits

---

namespace

• namespace: string

The namespace identifier.

Implementation of

INamespace.namespace

---

privateConnectivities

• privateConnectivities: IPrivateConnectivity[]

The private connectivities for the namespace, if any.

Implementation of

INamespace.privateConnectivities

---

regionStatus

• regionStatus: Object

The status of each region where the namespace is available. The id of the region is the key and the status is the value of the map.

Index signature

▪ [k: string]: INamespaceRegionStatus

Implementation of

INamespace.regionStatus

---

resourceVersion

• resourceVersion: string

The current version of the namespace specification. The next update operation will have to include this version.

Implementation of

INamespace.resourceVersion

---

spec

• Optional spec: null | INamespaceSpec

The namespace specification.

Implementation of

INamespace.spec

---

state

• state: string

The current state of the namespace.

Implementation of

INamespace.state

Methods

toJSON

▸ toJSON(): Object

Converts this Namespace to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Namespace

Creates a new Namespace instance using the specified properties.

Parameters

Name	Type	Description
properties?	INamespace	Properties to set

Returns

Namespace

Namespace instance

---

decode

▸ decode(reader, length?): Namespace

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

Namespace

Namespace

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Namespace

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

Namespace

Namespace

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

Parameters

Name	Type	Description
message	INamespace	Namespace message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	INamespace	Namespace message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): Namespace

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

Namespace

Namespace

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Namespace

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 Namespace message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	Namespace	Namespace
options?	IConversionOptions	Conversion options

Returns

Object

Plain object