co.cask.coopr.store.cluster

Interface ReadOnlyClusterStoreView

All Known Subinterfaces:

ClusterStore, ClusterStoreView

All Known Implementing Classes:

BaseSQLClusterStoreView, SQLAdminClusterStoreView, SQLClusterStore, SQLSystemClusterStoreView, SQLUserClusterStoreView

public interface ReadOnlyClusterStoreView

A read-only view of the cluster store as seen by a given account.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clusterExists(String clusterId) Return whether or not the cluster with the given id exists or not, where existence is determined by whether or not the cluster is in the store, and not by whether or not there is an active cluster with the given id.
List<Cluster>	getAllClusters() Get an immutable list of all clusters in the store.
List<ClusterSummary>	getAllClusterSummaries() Get an immutable list of summaries of all clusters in the store.
List<ClusterSummary>	getAllClusterSummaries(Set<Cluster.Status> states) Get an immutable list of summaries of all clusters in the store that are in one of the given cluster states.
Cluster	getCluster(String clusterId) Get a specific cluster by id.
List<ClusterJob>	getClusterJobs(String clusterId, int limit) Get all jobs performed or being performed on the given cluster owned by the given user.
Set<Node>	getClusterNodes(String clusterId) Get an immutable set of all nodes belonging to a specific cluster.
List<Cluster>	getNonTerminatedClusters() Get an immutable list of all clusters in the store that are not in the terminated state.

Method Detail

getAllClusters

List<Cluster> getAllClusters()
                             throws IOException

Get an immutable list of all clusters in the store.

Returns:

All clusters in the store.

Throws:

IOException - if there was a problem getting the clusters.

getAllClusterSummaries

List<ClusterSummary> getAllClusterSummaries()
                                            throws IOException

Get an immutable list of summaries of all clusters in the store.

Returns:

Immutable list of summaries of all clusters.

Throws:

IOException - if there was a problem getting the cluster summaries.

getAllClusterSummaries

List<ClusterSummary> getAllClusterSummaries(Set<Cluster.Status> states)
                                            throws IOException

Get an immutable list of summaries of all clusters in the store that are in one of the given cluster states.

Parameters:

states - returned clusters must be in one of these states.

Returns:

Immutable list of summaries of all clusters in the store that are in one of the given cluster states.

Throws:

IOException - if there was a problem getting the cluster summaries.

getNonTerminatedClusters

List<Cluster> getNonTerminatedClusters()
                                       throws IOException

Get an immutable list of all clusters in the store that are not in the terminated state.

Returns:

All clusters in the store.

Throws:

IOException - if there was a problem getting the clusters.

getCluster

Cluster getCluster(String clusterId)
                   throws IOException

Get a specific cluster by id.

Parameters:

clusterId - Id of the cluster to find.

Returns:

The cluster matching the id, or null if no cluster exists.

Throws:

IOException - if there was a problem getting the cluster.

clusterExists

boolean clusterExists(String clusterId)
                      throws IOException

Return whether or not the cluster with the given id exists or not, where existence is determined by whether or not the cluster is in the store, and not by whether or not there is an active cluster with the given id.

Parameters:

clusterId - Id of the cluster.

Returns:

True if the cluster exists, False if not.

Throws:

IOException

getClusterJobs

List<ClusterJob> getClusterJobs(String clusterId,
                              int limit)
                                throws IOException

Get all jobs performed or being performed on the given cluster owned by the given user.

Parameters:

clusterId - Id of the cluster for which to get jobs.

limit - Max number of jobs to return. If there are more, the most recent jobs will be returned. A negative number is interpreted as no limit.

Returns:

List of all jobs performed or being performed on the given cluster owned by the user, up to limit amount of jobs. If no jobs exist for the cluster owned by the user, an empty list is returned.

Throws:

IOException - if there was a problem getting the cluster jobs.

getClusterNodes

Set<Node> getClusterNodes(String clusterId)
                          throws IOException

Get an immutable set of all nodes belonging to a specific cluster.

Parameters:

clusterId - Id of the cluster whose nodes will be fetched.

Returns:

Set of all nodes belonging to specified cluster. Empty if no cluster or cluster nodes exist.

Throws:

IOException - if there was a problem getting the cluster nodes.