KlusterKite.NodeManager.WebApi.NodeManagerApi Class Reference

The node manager api More...

Public Member Functions
	NodeManagerApi (ActorSystem actorSystem, IPackageRepository packageRepository)
	Initializes a new instance of the NodeManagerApi class. More...
async Task< List< NodeDescription > >	GetActiveNodeDescriptions ()
	Gets current cluster active nodes descriptions More...
async Task< TemplatesUsageStatistics >	GetTemplateStatistics ()
	Gets current cluster node template usage for debug purposes More...
MigrationConnection	Migrations (RequestContext context)
	Gets the history of migrations More...
ConfigurationConnection	Configurations (RequestContext context)
	The connection to the Role More...
RolesConnection	Roles (RequestContext context)
	The connection to the Role More...
async Task< MutationResult< bool > >	UpgradeNode (string address)
	Manual node upgrade request More...
UsersConnection	Users (RequestContext context)
	The connection to the User More...

Public Attributes
List< PrivilegeDescription >	DefinedPrivilegeDescriptions => Utils.DefinedPrivileges.ToList()
	Gets the list of defined system privileges More...
NugetPackagesConnection	NugetPackages => new NugetPackagesConnection(this.packageRepository)
	Gets the list of packages in the nuget repository More...

Properties
ClusterManagement	ClusterManagement [get]
	Gets the cluster management More...

Detailed Description

The node manager api

Definition at line 37 of file NodeManagerApi.cs.

Constructor & Destructor Documentation

NodeManagerApi()

KlusterKite.NodeManager.WebApi.NodeManagerApi.NodeManagerApi	(	ActorSystem	actorSystem,
		IPackageRepository	packageRepository
	)

Initializes a new instance of the NodeManagerApi class.

Parameters

actorSystem	The actor system.
packageRepository	The package repository

Definition at line 56 of file NodeManagerApi.cs.

Member Function Documentation

Configurations()

ConfigurationConnection KlusterKite.NodeManager.WebApi.NodeManagerApi.Configurations

(

RequestContext

context

)

The connection to the Role

Parameters

context

The request context

Returns

The data connection

Definition at line 172 of file NodeManagerApi.cs.

GetActiveNodeDescriptions()

async Task<List<NodeDescription> > KlusterKite.NodeManager.WebApi.NodeManagerApi.GetActiveNodeDescriptions

(

)

Gets current cluster active nodes descriptions

Returns

The list of descriptions

Definition at line 105 of file NodeManagerApi.cs.

GetTemplateStatistics()

async Task<TemplatesUsageStatistics> KlusterKite.NodeManager.WebApi.NodeManagerApi.GetTemplateStatistics

(

)

Gets current cluster node template usage for debug purposes

Returns

Current cluster statistics

Definition at line 127 of file NodeManagerApi.cs.

Migrations()

MigrationConnection KlusterKite.NodeManager.WebApi.NodeManagerApi.Migrations

(

RequestContext

context

)

Gets the history of migrations

Parameters

context

The request context

Returns

the history of migrations

Definition at line 146 of file NodeManagerApi.cs.

Roles()

RolesConnection KlusterKite.NodeManager.WebApi.NodeManagerApi.Roles

(

RequestContext

context

)

The connection to the Role

Parameters

context

The request context

Returns

The data connection

Definition at line 190 of file NodeManagerApi.cs.

UpgradeNode()

async Task<MutationResult<bool> > KlusterKite.NodeManager.WebApi.NodeManagerApi.UpgradeNode

(

string

address

)

Manual node upgrade request

Parameters

address

Address of node to upgrade

Returns

Execution task

Definition at line 206 of file NodeManagerApi.cs.

Users()

UsersConnection KlusterKite.NodeManager.WebApi.NodeManagerApi.Users

(

RequestContext

context

)

The connection to the User

Parameters

context

The request context

Returns

The data connection

Definition at line 226 of file NodeManagerApi.cs.

Member Data Documentation

DefinedPrivilegeDescriptions

List<PrivilegeDescription> KlusterKite.NodeManager.WebApi.NodeManagerApi.DefinedPrivilegeDescriptions => Utils.DefinedPrivileges.ToList()

Gets the list of defined system privileges

Definition at line 72 of file NodeManagerApi.cs.

NugetPackages

NugetPackagesConnection KlusterKite.NodeManager.WebApi.NodeManagerApi.NugetPackages => new NugetPackagesConnection(this.packageRepository)

Gets the list of packages in the nuget repository

Definition at line 89 of file NodeManagerApi.cs.

Property Documentation

ClusterManagement

ClusterManagement KlusterKite.NodeManager.WebApi.NodeManagerApi.ClusterManagement

get

Gets the cluster management

Definition at line 79 of file NodeManagerApi.cs.

---

The documentation for this class was generated from the following file:

• KlusterKite.NodeManager/KlusterKite.NodeManager/WebApi/NodeManagerApi.cs