SenlinClusterService (OpenStack4j Core 3.0.5-SNAPSHOT API)

All Known Implementing Classes:

SenlinClusterServiceImpl
```
public interface SenlinClusterService
```
This interface defines all methods for the manipulation of Cluster

Author:

lion

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ActionID`	`action(String clusterID, ClusterActionCreate newClusterAction)` Service implementation which provides methods for manipulation of action
`Cluster`	`create(ClusterCreate newCluster)` `POST /v1/clusters` Creates a new `Cluster` out of a `ClusterCreate` object
`ActionResponse`	`delete(String clusterID)` Deletes the specified `Cluster` from the server.
`Cluster`	`get(String clusterID)` returns details of a `Cluster`.
`List<? extends Cluster>`	`list()` Gets a list of currently existing `Cluster`s.
`Cluster`	`update(String clusterID, ClusterCreate newCluster)` `PATCH /v1/clusters/{cluster_id}` Update a `Cluster` out of a `ClusterCreate` object

- Method Detail
  - list
```
List<? extends Cluster> list()
```
    Gets a list of currently existing Clusters.
    
    Returns:
    
    the list of Clusters
  - get
```
Cluster get(String clusterID)
```
    returns details of a Cluster.
    
    Parameters:
    
    clusterID - Id of Cluster
    
    Returns:
    
    Cluster
  - create
```
Cluster create(ClusterCreate newCluster)
```
    POST /v1/clusters
    Creates a new Cluster out of a ClusterCreate object
    
    Parameters:
    
    newCluster - ClusterCreate object out of which cluster is to be created
    
    Returns:
    
    new Cluster as returned from the server
  - delete
```
ActionResponse delete(String clusterID)
```
    Deletes the specified Cluster from the server.
    
    Parameters:
    
    clusterID - Id of Cluster
    
    Returns:
    
    the action response
  - update
```
Cluster update(String clusterID,
               ClusterCreate newCluster)
```
    PATCH /v1/clusters/{cluster_id}
    Update a Cluster out of a ClusterCreate object
    
    Parameters:
    
    clusterID - Id of Cluster
    
    newCluster - ClusterCreate object out of which stack is to be update
    
    Returns:
    
    new Cluster as returned from the server
  - action
```
ActionID action(String clusterID,
                ClusterActionCreate newClusterAction)
```
    Service implementation which provides methods for manipulation of action
    
    Returns:
    
    Action

Interface SenlinClusterService

Method Summary

Method Detail

list

get

create

delete

update

action