com.qubole.qds.sdk.java.api

Interface ClusterApi

public interface ClusterApi

Corresponds to http://www.qubole.com/docs/documentation/cluster-api/

Method Summary

Modifier and Type	Method and Description
InvokableBuilder<Command>	add_nodes(String labelOrId, int node_count) Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/add-node.html
InvokableBuilder<ClusterItem>	clone(String labelOrId, ClusterConfigBuilder configBuilder) Corresponds to cloning cluster under http://docs.qubole.com/en/latest/rest-api/cluster_api/clone-cluster.html
ClusterConfigBuilder	clusterConfig() Return a new cluster config builder.
InvokableBuilder<Cluster>	create(ClusterConfigBuilder configBuilder) Corresponds to http://www.qubole.com/docs/create-new-cluster/
InvokableBuilder<ClusterItem>	delete(String labelOrId) Corresponds to http://www.qubole.com/docs/delete-cluster/
InvokableBuilder<ClusterItem>	edit(String labelOrId, ClusterConfigBuilder configBuilder) Corresponds to http://www.qubole.com/docs/edit-cluster/
InvokableBuilder<ClusterItem>	information(String labelOrId) Corresponds to http://www.qubole.com/docs/get-cluster-information/
InvokableBuilder<List<ClusterItem>>	list() Corresponds to http://www.qubole.com/docs/list-clusters/
InvokableBuilder<ClusterMetrics>	metrics(String labelOrId, String metrics, String hostname, String interval) Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/metrics-cluster.html
InvokableBuilder<Command>	remove_node(String labelOrId, String private_dns) Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/remove-node.html
InvokableBuilder<Command>	replace_node(String labelOrId, String private_dns) Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/replace-node.html
InvokableBuilder<Message>	start(String labelOrId) Corresponds to http://www.qubole.com/docs/start-terminate-cluster/ for "start"
InvokableBuilder<ClusterState>	state(String labelOrId) Corresponds to http://www.qubole.com/docs/get-cluster-state/
InvokableBuilder<Message>	terminate(String labelOrId) Corresponds to http://www.qubole.com/docs/start-terminate-cluster/ for "terminate"

Method Detail

list

InvokableBuilder<List<ClusterItem>> list()

Corresponds to http://www.qubole.com/docs/list-clusters/

Returns:

new builder

state

InvokableBuilder<ClusterState> state(String labelOrId)

Corresponds to http://www.qubole.com/docs/get-cluster-state/

Parameters:

labelOrId - the Cluster label/id

Returns:

new builder

metrics

InvokableBuilder<ClusterMetrics> metrics(String labelOrId,
                                         String metrics,
                                         String hostname,
                                         String interval)

Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/metrics-cluster.html

Parameters:

labelOrId - the Cluster label/id

metrics - metric to monitor.

hostname - hostname for which metric values are required.

interval - interval for which the metric values are required.

Returns:

new builder

information

InvokableBuilder<ClusterItem> information(String labelOrId)

Corresponds to http://www.qubole.com/docs/get-cluster-information/

Parameters:

labelOrId - the Cluster label/id

Returns:

new builder

start

InvokableBuilder<Message> start(String labelOrId)

Corresponds to http://www.qubole.com/docs/start-terminate-cluster/ for "start"

Parameters:

labelOrId - the Cluster label/id

Returns:

new builder

terminate

InvokableBuilder<Message> terminate(String labelOrId)

Corresponds to http://www.qubole.com/docs/start-terminate-cluster/ for "terminate"

Parameters:

labelOrId - the Cluster label/id

Returns:

new builder

edit

InvokableBuilder<ClusterItem> edit(String labelOrId,
                                   ClusterConfigBuilder configBuilder)

Corresponds to http://www.qubole.com/docs/edit-cluster/

Parameters:

labelOrId - the Cluster label/id

configBuilder - config values - use clusterConfig()

Returns:

new builder

create

InvokableBuilder<Cluster> create(ClusterConfigBuilder configBuilder)

Corresponds to http://www.qubole.com/docs/create-new-cluster/

Parameters:

configBuilder - config values - use clusterConfig()

Returns:

new builder

delete

InvokableBuilder<ClusterItem> delete(String labelOrId)

Corresponds to http://www.qubole.com/docs/delete-cluster/

Parameters:

labelOrId - the Cluster label/id

Returns:

new builder

add_nodes

InvokableBuilder<Command> add_nodes(String labelOrId,
                                    int node_count)

Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/add-node.html

Parameters:

labelOrId - the Cluster label/id

node_count - the number of nodes to add

Returns:

new builder

replace_node

InvokableBuilder<Command> replace_node(String labelOrId,
                                       String private_dns)

Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/replace-node.html

Parameters:

labelOrId - the Cluster label/id

private_dns - the dns of slave to replace

Returns:

new builder

remove_node

InvokableBuilder<Command> remove_node(String labelOrId,
                                      String private_dns)

Corresponds to http://docs.qubole.com/en/latest/rest-api/cluster_api/remove-node.html

Parameters:

labelOrId - the Cluster label/id

private_dns - the dns of slave to remove

Returns:

new builder

clone

InvokableBuilder<ClusterItem> clone(String labelOrId,
                                    ClusterConfigBuilder configBuilder)

Corresponds to cloning cluster under http://docs.qubole.com/en/latest/rest-api/cluster_api/clone-cluster.html

Parameters:

labelOrId - the Cluster label/id

configBuilder - config values - use clusterConfig()

Returns:

new builder

clusterConfig

ClusterConfigBuilder clusterConfig()

Return a new cluster config builder. Can be used with apis such as edit(String, ClusterConfigBuilder)

Returns:

builder