Class: RegisterNamespaceRequest
workflowservice.v1.RegisterNamespaceRequest
Represents a RegisterNamespaceRequest.
Implements
Constructors
constructor
• new RegisterNamespaceRequest(properties?): RegisterNamespaceRequest
Constructs a new RegisterNamespaceRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRegisterNamespaceRequest | Properties to set |
Returns
Properties
activeClusterName
• activeClusterName: string
RegisterNamespaceRequest activeClusterName.
Implementation of
IRegisterNamespaceRequest.activeClusterName
clusters
• clusters: IClusterReplicationConfig[]
RegisterNamespaceRequest clusters.
Implementation of
IRegisterNamespaceRequest.clusters
data
• data: Object
A key-value map for any customized purpose.
Index signature
▪ [k: string]: string
Implementation of
IRegisterNamespaceRequest.data
description
• description: string
RegisterNamespaceRequest description.
Implementation of
IRegisterNamespaceRequest.description
historyArchivalState
• historyArchivalState: ArchivalState
If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.
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
If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.
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
create
▸ create(properties?): RegisterNamespaceRequest
Creates a new RegisterNamespaceRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRegisterNamespaceRequest | Properties to set |
Returns
RegisterNamespaceRequest instance
decode
▸ decode(reader, length?): RegisterNamespaceRequest
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RegisterNamespaceRequest
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
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 | IRegisterNamespaceRequest | 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 | IRegisterNamespaceRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RegisterNamespaceRequest
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 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