com.netflix.genie.client.apis

Interface ClusterService

public interface ClusterService

An interface that provides all methods needed for the Genie cluster client implementation.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLUSTER_URL_SUFFIX Path to Clusters.

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<java.lang.Void>	addCommandsToCluster(java.lang.String clusterId, java.util.List<java.lang.String> commandIds) Method to add commands to a cluster in Genie.
retrofit2.Call<java.lang.Void>	addConfigsToCluster(java.lang.String clusterId, java.util.Set<java.lang.String> configs) Method to add configs to a cluster in Genie.
retrofit2.Call<java.lang.Void>	addTagsToCluster(java.lang.String clusterId, java.util.Set<java.lang.String> tags) Method to add tags to a cluster in Genie.
retrofit2.Call<java.lang.Void>	createCluster(Cluster cluster) Method to create a cluster in Genie.
retrofit2.Call<java.lang.Void>	deleteAllClusters() Method to delete all clusters in Genie.
retrofit2.Call<java.lang.Void>	deleteCluster(java.lang.String clusterId) Method to delete a cluster in Genie.
retrofit2.Call<Cluster>	getCluster(java.lang.String clusterId) Method to fetch a single job from Genie.
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode>	getClusters(java.lang.String name, java.util.List<java.lang.String> statusList, java.util.List<java.lang.String> tagList, java.lang.Long minUpdateTime, java.lang.Long maxUpdateTime) Method to get clusters from Genie based on filters specified.
retrofit2.Call<java.util.List<Command>>	getCommandsForCluster(java.lang.String clusterId) Method to get commmands for a cluster in Genie.
retrofit2.Call<java.util.Set<java.lang.String>>	getConfigsForCluster(java.lang.String clusterId) Method to get configs for a cluster in Genie.
retrofit2.Call<java.util.Set<java.lang.String>>	getTagsForCluster(java.lang.String clusterId) Method to get tags for a cluster in Genie.
retrofit2.Call<java.lang.Void>	patchCluster(java.lang.String clusterId, com.github.fge.jsonpatch.JsonPatch patch) Patch a cluster using JSON Patch.
retrofit2.Call<java.lang.Void>	removeAllCommandsForCluster(java.lang.String clusterId) Method to delete all commands for a cluster in Genie.
retrofit2.Call<java.lang.Void>	removeAllConfigsForCluster(java.lang.String clusterId) Method to delete all configs for a cluster in Genie.
retrofit2.Call<java.lang.Void>	removeAllTagsForCluster(java.lang.String clusterId) Method to delete all tags for a cluster in Genie.
retrofit2.Call<java.lang.Void>	removeCommandForCluster(java.lang.String clusterId, java.lang.String commandId) Method to delete a command for a cluster in Genie.
retrofit2.Call<java.lang.Void>	removeTagForCluster(java.lang.String clusterId, java.lang.String tag) Method to delete a tag for a cluster in Genie.
retrofit2.Call<java.lang.Void>	setCommandsForCluster(java.lang.String clusterId, java.util.List<java.lang.String> commandIds) Method to override and set commands for a cluster in Genie.
retrofit2.Call<java.lang.Void>	updateCluster(java.lang.String clusterId, Cluster cluster) Method to update a cluster in Genie.
retrofit2.Call<java.lang.Void>	updateConfigsForCluster(java.lang.String clusterId, java.util.Set<java.lang.String> configs) Method to update configs for a cluster in Genie.
retrofit2.Call<java.lang.Void>	updateTagsForCluster(java.lang.String clusterId, java.util.Set<java.lang.String> tags) Method to update tags for a cluster in Genie.

Field Detail

CLUSTER_URL_SUFFIX

static final java.lang.String CLUSTER_URL_SUFFIX

Path to Clusters.

See Also:

Constant Field Values

Method Detail

createCluster

@POST(value="/api/v3/clusters")
retrofit2.Call<java.lang.Void> createCluster(@Body
                                                                             Cluster cluster)

Method to create a cluster in Genie.

Parameters:

cluster - The cluster object.

Returns:

A callable object.

updateCluster

@PUT(value="/api/v3/clusters/{id}")
retrofit2.Call<java.lang.Void> updateCluster(@Path(value="id")
                                                                                 java.lang.String clusterId,
                                                                                 @Body
                                                                                 Cluster cluster)

Method to update a cluster in Genie.

Parameters:

clusterId - The id of the cluster to update.

cluster - The cluster object.

Returns:

A callable object.

getClusters

@GET(value="/api/v3/clusters")
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode> getClusters(@Query(value="name")
                                                                                                   java.lang.String name,
                                                                                                   @Query(value="status")
                                                                                                   java.util.List<java.lang.String> statusList,
                                                                                                   @Query(value="tag")
                                                                                                   java.util.List<java.lang.String> tagList,
                                                                                                   @Query(value="minUpdateTime")
                                                                                                   java.lang.Long minUpdateTime,
                                                                                                   @Query(value="maxUpdateTime")
                                                                                                   java.lang.Long maxUpdateTime)

Method to get clusters from Genie based on filters specified.

Parameters:

name - The name of the cluster.

statusList - The list of statuses.

tagList - The list of tags.

minUpdateTime - Minimum Time after which cluster was updated.

maxUpdateTime - Maximum Time before which cluster was updated.

Returns:

A callable object.

getCluster

@GET(value="/api/v3/clusters/{id}")
retrofit2.Call<Cluster> getCluster(@Path(value="id")
                                                                       java.lang.String clusterId)

Method to fetch a single job from Genie.

Parameters:

clusterId - The id of the cluster to get.

Returns:

A callable object.

deleteCluster

@DELETE(value="/api/v3/clusters/{id}")
retrofit2.Call<java.lang.Void> deleteCluster(@Path(value="id")
                                                                                    java.lang.String clusterId)

Method to delete a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

Returns:

A callable object.

deleteAllClusters

@DELETE(value="/api/v3/clusters")
retrofit2.Call<java.lang.Void> deleteAllClusters()

Method to delete all clusters in Genie.

Returns:

A callable object.

patchCluster

@PATCH(value="/api/v3/clusters/{id}")
retrofit2.Call<java.lang.Void> patchCluster(@Path(value="id")
                                                                                  java.lang.String clusterId,
                                                                                  @Body
                                                                                  com.github.fge.jsonpatch.JsonPatch patch)

Patch a cluster using JSON Patch.

Parameters:

clusterId - The id of the cluster to patch

patch - The JSON Patch instructions

Returns:

A callable object.

getCommandsForCluster

@GET(value="/api/v3/clusters/{id}/commands")
retrofit2.Call<java.util.List<Command>> getCommandsForCluster(@Path(value="id")
                                                                                                           java.lang.String clusterId)

Method to get commmands for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

Returns:

A callable object.

addCommandsToCluster

@POST(value="/api/v3/clusters/{id}/commands")
retrofit2.Call<java.lang.Void> addCommandsToCluster(@Path(value="id")
                                                                                                  java.lang.String clusterId,
                                                                                                  @Body
                                                                                                  java.util.List<java.lang.String> commandIds)

Method to add commands to a cluster in Genie.

Parameters:

clusterId - The id of the cluster..

commandIds - The command Ids to be added.

Returns:

A callable object.

setCommandsForCluster

@PUT(value="/api/v3/clusters/{id}/commands")
retrofit2.Call<java.lang.Void> setCommandsForCluster(@Path(value="id")
                                                                                                  java.lang.String clusterId,
                                                                                                  @Body
                                                                                                  java.util.List<java.lang.String> commandIds)

Method to override and set commands for a cluster in Genie.

Parameters:

clusterId - The id of the cluster..

commandIds - The command Ids to be added.

Returns:

A callable object.

removeCommandForCluster

@DELETE(value="/api/v3/clusters/{id}/commands/{commandId}")
retrofit2.Call<java.lang.Void> removeCommandForCluster(@Path(value="id")
                                                                                                                   java.lang.String clusterId,
                                                                                                                   @Path(value="commandId")
                                                                                                                   java.lang.String commandId)

Method to delete a command for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

commandId - The command to delete.

Returns:

A callable object.

removeAllCommandsForCluster

@DELETE(value="/api/v3/clusters/{id}/commands")
retrofit2.Call<java.lang.Void> removeAllCommandsForCluster(@Path(value="id")
                                                                                                           java.lang.String clusterId)

Method to delete all commands for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

Returns:

A callable object.

getConfigsForCluster

@GET(value="/api/v3/clusters/{id}/configs")
retrofit2.Call<java.util.Set<java.lang.String>> getConfigsForCluster(@Path(value="id")
                                                                                                                 java.lang.String clusterId)

Method to get configs for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

Returns:

A callable object.

addConfigsToCluster

@POST(value="/api/v3/clusters/{id}/configs")
retrofit2.Call<java.lang.Void> addConfigsToCluster(@Path(value="id")
                                                                                                java.lang.String clusterId,
                                                                                                @Body
                                                                                                java.util.Set<java.lang.String> configs)

Method to add configs to a cluster in Genie.

Parameters:

clusterId - The id of the cluster..

configs - The configs to be added.

Returns:

A callable object.

updateConfigsForCluster

@PUT(value="/api/v3/clusters/{id}/configs")
retrofit2.Call<java.lang.Void> updateConfigsForCluster(@Path(value="id")
                                                                                                   java.lang.String clusterId,
                                                                                                   @Body
                                                                                                   java.util.Set<java.lang.String> configs)

Method to update configs for a cluster in Genie.

Parameters:

clusterId - The id of the cluster..

configs - The configs to be added.

Returns:

A callable object.

removeAllConfigsForCluster

@DELETE(value="/api/v3/clusters/{id}/configs")
retrofit2.Call<java.lang.Void> removeAllConfigsForCluster(@Path(value="id")
                                                                                                         java.lang.String clusterId)

Method to delete all configs for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

Returns:

A callable object.

getTagsForCluster

@GET(value="/api/v3/clusters/{id}/tags")
retrofit2.Call<java.util.Set<java.lang.String>> getTagsForCluster(@Path(value="id")
                                                                                                           java.lang.String clusterId)

Method to get tags for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

Returns:

A callable object.

addTagsToCluster

@POST(value="/api/v3/clusters/{id}/tags")
retrofit2.Call<java.lang.Void> addTagsToCluster(@Path(value="id")
                                                                                          java.lang.String clusterId,
                                                                                          @Body
                                                                                          java.util.Set<java.lang.String> tags)

Method to add tags to a cluster in Genie.

Parameters:

clusterId - The id of the cluster..

tags - The tags to be added.

Returns:

A callable object.

updateTagsForCluster

@PUT(value="/api/v3/clusters/{id}/tags")
retrofit2.Call<java.lang.Void> updateTagsForCluster(@Path(value="id")
                                                                                             java.lang.String clusterId,
                                                                                             @Body
                                                                                             java.util.Set<java.lang.String> tags)

Method to update tags for a cluster in Genie.

Parameters:

clusterId - The id of the cluster..

tags - The tags to be added.

Returns:

A callable object.

removeTagForCluster

@DELETE(value="/api/v3/clusters/{id}/tags/{tag}")
retrofit2.Call<java.lang.Void> removeTagForCluster(@Path(value="id")
                                                                                                     java.lang.String clusterId,
                                                                                                     @Path(value="tag")
                                                                                                     java.lang.String tag)

Method to delete a tag for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

tag - The tag to delete.

Returns:

A callable object.

removeAllTagsForCluster

@DELETE(value="/api/v3/clusters/{id}/tags")
retrofit2.Call<java.lang.Void> removeAllTagsForCluster(@Path(value="id")
                                                                                                   java.lang.String clusterId)

Method to delete all tags for a cluster in Genie.

Parameters:

clusterId - The id of the cluster.

Returns:

A callable object.