Class: RegisterNamespaceRequest

workflowservice.v1.RegisterNamespaceRequest

Represents a RegisterNamespaceRequest.

Properties

activeClusterName

• activeClusterName: string

RegisterNamespaceRequest activeClusterName.

---

clusters

• clusters: $Properties[]

RegisterNamespaceRequest clusters.

---

data

• data: Object

A key-value map for any customized purpose.

Index signature

▪ [k: string]: string

---

description

• description: string

RegisterNamespaceRequest description.

---

historyArchivalState

• historyArchivalState: ArchivalState

If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.

---

historyArchivalUri

• historyArchivalUri: string

RegisterNamespaceRequest historyArchivalUri.

---

isGlobalNamespace

• isGlobalNamespace: boolean

RegisterNamespaceRequest isGlobalNamespace.

---

namespace

• namespace: string

RegisterNamespaceRequest namespace.

---

ownerEmail

• ownerEmail: string

RegisterNamespaceRequest ownerEmail.

---

securityToken

• securityToken: string

RegisterNamespaceRequest securityToken.

---

visibilityArchivalState

• visibilityArchivalState: ArchivalState

If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.

---

visibilityArchivalUri

• visibilityArchivalUri: string

RegisterNamespaceRequest visibilityArchivalUri.

---

workflowExecutionRetentionPeriod

• Optional workflowExecutionRetentionPeriod: null | $Properties

RegisterNamespaceRequest workflowExecutionRetentionPeriod.

Methods

toJSON

▸ toJSON(): Object

Converts this RegisterNamespaceRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): RegisterNamespaceRequest & $Properties

Creates a new RegisterNamespaceRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Properties	Properties to set

Returns

RegisterNamespaceRequest & $Properties

RegisterNamespaceRequest instance

▸ create(properties?): RegisterNamespaceRequest

Parameters

Name	Type
properties?	$Properties

Returns

RegisterNamespaceRequest

---

decode

▸ decode(reader, length?): RegisterNamespaceRequest & $Properties

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

RegisterNamespaceRequest & $Properties

RegisterNamespaceRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): RegisterNamespaceRequest & $Properties

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

Parameters

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

Returns

RegisterNamespaceRequest & $Properties

RegisterNamespaceRequest

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

Parameters

Name	Type	Description
message	$Properties	RegisterNamespaceRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	$Properties	RegisterNamespaceRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): RegisterNamespaceRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

RegisterNamespaceRequest

RegisterNamespaceRequest

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	RegisterNamespaceRequest	RegisterNamespaceRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object