@hashgraph/solo
Preparing search index...
src/business/runtime-state/api/remote-config-runtime-state-api
RemoteConfigRuntimeStateApi
Interface RemoteConfigRuntimeStateApi
interface
RemoteConfigRuntimeStateApi
{
configuration
?:
RemoteConfig
;
currentCluster
:
string
;
addCommandToHistory
(
command
:
string
)
:
void
;
create
(
argv
:
ArgvStruct
,
ledgerPhase
:
LedgerPhase
,
nodeAliases
:
NodeAliases
,
namespace
:
NamespaceName
,
deployment
:
string
,
clusterReference
:
string
,
context
:
string
,
dnsBaseDomain
:
string
,
dnsConsensusNodePattern
:
string
,
)
:
Promise
<
void
>
;
createConfigMap
(
namespace
:
NamespaceName
,
context
:
string
,
)
:
Promise
<
ConfigMap
>
;
createFromExisting
(
namespace
:
NamespaceName
,
clusterReference
:
string
,
deployment
:
string
,
componentFactory
:
ComponentFactoryApi
,
dnsBaseDomain
:
string
,
dnsConsensusNodePattern
:
string
,
existingClusterContext
:
string
,
argv
:
ArgvStruct
,
nodeAliases
:
NodeAliases
,
)
:
Promise
<
void
>
;
deleteComponents
()
:
Promise
<
void
>
;
extractContextFromConsensusNodes
(
nodeAlias
:
`
node
${
number
}
`
)
:
string
;
getClusterRefs
()
:
ClusterReferences
;
getConsensusNodes
()
:
ConsensusNode
[]
;
getContexts
()
:
string
[]
;
getNamespace
()
:
NamespaceName
;
isLoaded
()
:
boolean
;
load
(
namespace
?:
NamespaceName
,
context
?:
string
)
:
Promise
<
void
>
;
loadAndValidate
(
argv
:
{
_
:
string
[]
}
&
AnyObject
,
validate
?:
boolean
,
skipConsensusNodesValidation
?:
boolean
,
)
:
Promise
<
void
>
;
persist
()
:
Promise
<
void
>
;
populateFromExisting
(
namespace
:
NamespaceName
,
context
:
string
,
)
:
Promise
<
void
>
;
remoteConfigExists
(
namespace
:
NamespaceName
,
context
:
string
,
)
:
Promise
<
boolean
>
;
}
Implemented by
RemoteConfigRuntimeState
Index
Properties
configuration?
current
Cluster
Methods
add
Command
To
History
create
create
Config
Map
create
From
Existing
delete
Components
extract
Context
From
Consensus
Nodes
get
Cluster
Refs
get
Consensus
Nodes
get
Contexts
get
Namespace
is
Loaded
load
load
And
Validate
persist
populate
From
Existing
remote
Config
Exists
Properties
Optional
configuration
configuration
?:
RemoteConfig
current
Cluster
currentCluster
:
string
Methods
add
Command
To
History
addCommandToHistory
(
command
:
string
)
:
void
Parameters
command
:
string
Returns
void
create
create
(
argv
:
ArgvStruct
,
ledgerPhase
:
LedgerPhase
,
nodeAliases
:
NodeAliases
,
namespace
:
NamespaceName
,
deployment
:
string
,
clusterReference
:
string
,
context
:
string
,
dnsBaseDomain
:
string
,
dnsConsensusNodePattern
:
string
,
)
:
Promise
<
void
>
Parameters
argv
:
ArgvStruct
ledgerPhase
:
LedgerPhase
nodeAliases
:
NodeAliases
namespace
:
NamespaceName
deployment
:
string
clusterReference
:
string
context
:
string
dnsBaseDomain
:
string
dnsConsensusNodePattern
:
string
Returns
Promise
<
void
>
create
Config
Map
createConfigMap
(
namespace
:
NamespaceName
,
context
:
string
)
:
Promise
<
ConfigMap
>
Parameters
namespace
:
NamespaceName
context
:
string
Returns
Promise
<
ConfigMap
>
create
From
Existing
createFromExisting
(
namespace
:
NamespaceName
,
clusterReference
:
string
,
deployment
:
string
,
componentFactory
:
ComponentFactoryApi
,
dnsBaseDomain
:
string
,
dnsConsensusNodePattern
:
string
,
existingClusterContext
:
string
,
argv
:
ArgvStruct
,
nodeAliases
:
NodeAliases
,
)
:
Promise
<
void
>
Parameters
namespace
:
NamespaceName
clusterReference
:
string
deployment
:
string
componentFactory
:
ComponentFactoryApi
dnsBaseDomain
:
string
dnsConsensusNodePattern
:
string
existingClusterContext
:
string
argv
:
ArgvStruct
nodeAliases
:
NodeAliases
Returns
Promise
<
void
>
delete
Components
deleteComponents
()
:
Promise
<
void
>
Returns
Promise
<
void
>
extract
Context
From
Consensus
Nodes
extractContextFromConsensusNodes
(
nodeAlias
:
`
node
${
number
}
`
)
:
string
Parameters
nodeAlias
:
`
node
${
number
}
`
Returns
string
get
Cluster
Refs
getClusterRefs
()
:
ClusterReferences
Returns
ClusterReferences
get
Consensus
Nodes
getConsensusNodes
()
:
ConsensusNode
[]
Returns
ConsensusNode
[]
get
Contexts
getContexts
()
:
string
[]
Returns
string
[]
get
Namespace
getNamespace
()
:
NamespaceName
Returns
NamespaceName
is
Loaded
isLoaded
()
:
boolean
Returns
boolean
load
load
(
namespace
?:
NamespaceName
,
context
?:
string
)
:
Promise
<
void
>
Parameters
Optional
namespace
:
NamespaceName
Optional
context
:
string
Returns
Promise
<
void
>
load
And
Validate
loadAndValidate
(
argv
:
{
_
:
string
[]
}
&
AnyObject
,
validate
?:
boolean
,
skipConsensusNodesValidation
?:
boolean
,
)
:
Promise
<
void
>
Parameters
argv
:
{
_
:
string
[]
}
&
AnyObject
Optional
validate
:
boolean
Optional
skipConsensusNodesValidation
:
boolean
Returns
Promise
<
void
>
persist
persist
()
:
Promise
<
void
>
Returns
Promise
<
void
>
populate
From
Existing
populateFromExisting
(
namespace
:
NamespaceName
,
context
:
string
)
:
Promise
<
void
>
Parameters
namespace
:
NamespaceName
context
:
string
Returns
Promise
<
void
>
remote
Config
Exists
remoteConfigExists
(
namespace
:
NamespaceName
,
context
:
string
)
:
Promise
<
boolean
>
Parameters
namespace
:
NamespaceName
context
:
string
Returns
Promise
<
boolean
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
configuration
current
Cluster
Methods
add
Command
To
History
create
create
Config
Map
create
From
Existing
delete
Components
extract
Context
From
Consensus
Nodes
get
Cluster
Refs
get
Consensus
Nodes
get
Contexts
get
Namespace
is
Loaded
load
load
And
Validate
persist
populate
From
Existing
remote
Config
Exists
@hashgraph/solo
Loading...