KlusterKite  0.0.0
A framework to create scalable and redundant services based on awesome Akka.Net project.
KlusterKite.API.Client.INodeConnection< T > Interface Template Reference

Describes node connection More...

Public Member Functions

Task< QueryResult< T > > Query (Expression< Func< T, bool >> filter, IEnumerable< SortingCondition > sort, int? limit, int? offset, ApiRequest apiRequest)
 Query the datasource for nodes More...
 
Task< MutationResult< T > > Create (T newNode)
 Creates a new node More...
 
Task< MutationResult< T > > Update (object id, T newNode, ApiRequest request)
 Updates a node More...
 
Task< MutationResult< T > > Delete (object id)
 Removes a node from the data store More...
 

Detailed Description

Describes node connection

Template Parameters
TThe type of node
Type Constraints
T :class 
T :new() 

Definition at line 23 of file INodeConnection.cs.

Member Function Documentation

◆ Create()

Task<MutationResult<T> > KlusterKite.API.Client.INodeConnection< T >.Create ( newNode)

Creates a new node

Parameters
newNodeThe new node data
Returns
The new node after creation

◆ Delete()

Task<MutationResult<T> > KlusterKite.API.Client.INodeConnection< T >.Delete ( object  id)

Removes a node from the data store

Parameters
idThe node id
Returns
The old node data

◆ Query()

Task<QueryResult<T> > KlusterKite.API.Client.INodeConnection< T >.Query ( Expression< Func< T, bool >>  filter,
IEnumerable< SortingCondition sort,
int?  limit,
int?  offset,
ApiRequest  apiRequest 
)

Query the datasource for nodes

Parameters
filterThe filtering condition
sortThe sorting method
limitThe maximum number of objects to get
offsetThe number of objects to skip
apiRequestThe original api request
Returns
The nodes list

◆ Update()

Task<MutationResult<T> > KlusterKite.API.Client.INodeConnection< T >.Update ( object  id,
newNode,
ApiRequest  request 
)

Updates a node

Parameters
idThe node id
newNodeThe new node data
requestThe list of an updated Fields.
Returns
The new node after update

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