Skip to main content

Class: 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?: $Properties | null

RegisterNamespaceRequest workflowExecutionRetentionPeriod.

Methods​

toJSON()​

toJSON(): object

Converts this RegisterNamespaceRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RegisterNamespaceRequest & $Properties

Creates a new RegisterNamespaceRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RegisterNamespaceRequest & $Properties

RegisterNamespaceRequest instance

Call Signature​

static create(properties?): RegisterNamespaceRequest

Creates a new RegisterNamespaceRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RegisterNamespaceRequest

RegisterNamespaceRequest instance

decode()​

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

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

RegisterNamespaceRequest & $Properties

RegisterNamespaceRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RegisterNamespaceRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

RegisterNamespaceRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RegisterNamespaceRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RegisterNamespaceRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

RegisterNamespaceRequest

RegisterNamespaceRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RegisterNamespaceRequest

RegisterNamespaceRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object