Skip to main content

Class: RegisterNamespaceRequest

workflowservice.v1.RegisterNamespaceRequest

Represents a RegisterNamespaceRequest.

Implements#

Constructors#

constructor#

new RegisterNamespaceRequest(properties?)

Constructs a new RegisterNamespaceRequest.

Parameters#

NameType
properties?IRegisterNamespaceRequest

Properties#

activeClusterName#

activeClusterName: string

RegisterNamespaceRequest activeClusterName.

Implementation of#

IRegisterNamespaceRequest.activeClusterName


clusters#

clusters: IClusterReplicationConfig[]

RegisterNamespaceRequest clusters.

Implementation of#

IRegisterNamespaceRequest.clusters


data#

data: Object

RegisterNamespaceRequest data.

Index signature#

▪ [k: string]: string

Implementation of#

IRegisterNamespaceRequest.data


description#

description: string

RegisterNamespaceRequest description.

Implementation of#

IRegisterNamespaceRequest.description


historyArchivalState#

historyArchivalState: ArchivalState

RegisterNamespaceRequest historyArchivalState.

Implementation of#

IRegisterNamespaceRequest.historyArchivalState


historyArchivalUri#

historyArchivalUri: string

RegisterNamespaceRequest historyArchivalUri.

Implementation of#

IRegisterNamespaceRequest.historyArchivalUri


isGlobalNamespace#

isGlobalNamespace: boolean

RegisterNamespaceRequest isGlobalNamespace.

Implementation of#

IRegisterNamespaceRequest.isGlobalNamespace


namespace#

namespace: string

RegisterNamespaceRequest namespace.

Implementation of#

IRegisterNamespaceRequest.namespace


ownerEmail#

ownerEmail: string

RegisterNamespaceRequest ownerEmail.

Implementation of#

IRegisterNamespaceRequest.ownerEmail


securityToken#

securityToken: string

RegisterNamespaceRequest securityToken.

Implementation of#

IRegisterNamespaceRequest.securityToken


visibilityArchivalState#

visibilityArchivalState: ArchivalState

RegisterNamespaceRequest visibilityArchivalState.

Implementation of#

IRegisterNamespaceRequest.visibilityArchivalState


visibilityArchivalUri#

visibilityArchivalUri: string

RegisterNamespaceRequest visibilityArchivalUri.

Implementation of#

IRegisterNamespaceRequest.visibilityArchivalUri


workflowExecutionRetentionPeriod#

Optional workflowExecutionRetentionPeriod: null | IDuration

RegisterNamespaceRequest workflowExecutionRetentionPeriod.

Implementation of#

IRegisterNamespaceRequest.workflowExecutionRetentionPeriod

Methods#

toJSON#

toJSON(): Object

Converts this RegisterNamespaceRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): RegisterNamespaceRequest

Decodes a RegisterNamespaceRequest message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

RegisterNamespaceRequest

RegisterNamespaceRequest


decodeDelimited#

Static decodeDelimited(reader): RegisterNamespaceRequest

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

RegisterNamespaceRequest

RegisterNamespaceRequest


encode#

Static encode(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIRegisterNamespaceRequestRegisterNamespaceRequest message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIRegisterNamespaceRequestRegisterNamespaceRequest message or plain object to encode
writer?Writer-

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageRegisterNamespaceRequestRegisterNamespaceRequest
options?IConversionOptions-

Returns#

Object

Plain object