com.netflix.genie.client.apis

Interface CommandService

public interface CommandService

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

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMAND_URL_SUFFIX Path to Commands.

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<java.lang.Void>	addApplicationsToCommand(java.lang.String commandId, java.util.List<java.lang.String> applicationIds) Method to add applications to a command in Genie.
retrofit2.Call<java.lang.Void>	addConfigsToCommand(java.lang.String commandId, java.util.Set<java.lang.String> configs) Method to add configs to a command in Genie.
retrofit2.Call<java.lang.Void>	addTagsToCommand(java.lang.String commandId, java.util.Set<java.lang.String> tags) Method to add tags to a command in Genie.
retrofit2.Call<java.lang.Void>	createCommand(Command command) Method to create a command in Genie.
retrofit2.Call<java.lang.Void>	deleteAllCommands() Method to delete all commands in Genie.
retrofit2.Call<java.lang.Void>	deleteCommand(java.lang.String commandId) Method to delete a command in Genie.
retrofit2.Call<java.util.List<Application>>	getApplicationsForCommand(java.lang.String commandId) Method to get applications for a command in Genie.
retrofit2.Call<java.util.List<Cluster>>	getClustersForCommand(java.lang.String commandId) Method to get clusters for a command in Genie.
retrofit2.Call<Command>	getCommand(java.lang.String commandId) Method to fetch a single job from Genie.
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode>	getCommands(java.lang.String name, java.lang.String user, java.util.List<java.lang.String> statusList, java.util.List<java.lang.String> tagList) Method to get all commands from Genie filtered based on query params.
retrofit2.Call<java.util.Set<java.lang.String>>	getConfigsForCommand(java.lang.String commandId) Method to get configs for a command in Genie.
retrofit2.Call<java.util.Set<java.lang.String>>	getTagsForCommand(java.lang.String commandId) Method to get tags for a command in Genie.
retrofit2.Call<java.lang.Void>	patchCommand(java.lang.String commandId, com.github.fge.jsonpatch.JsonPatch patch) Patch a command using JSON Patch.
retrofit2.Call<java.lang.Void>	removeAllApplicationsForCommand(java.lang.String commandId) Method to delete all applications for a command in Genie.
retrofit2.Call<java.lang.Void>	removeAllConfigsForCommand(java.lang.String commandId) Method to delete all configs for a command in Genie.
retrofit2.Call<java.lang.Void>	removeAllTagsForCommand(java.lang.String commandId) Method to delete all tags for a command in Genie.
retrofit2.Call<java.lang.Void>	removeApplicationForCommand(java.lang.String commandId, java.lang.String applicationId) Method to delete a application for a command in Genie.
retrofit2.Call<java.lang.Void>	removeTagForCommand(java.lang.String commandId, java.lang.String tag) Method to delete a tag for a command in Genie.
retrofit2.Call<java.lang.Void>	setApplicationsForCommand(java.lang.String commandId, java.util.List<java.lang.String> applicationIds) Method to override and set applications for a command in Genie.
retrofit2.Call<java.lang.Void>	updateCommand(java.lang.String commandId, Command command) Method to update a command in Genie.
retrofit2.Call<java.lang.Void>	updateConfigsForCommand(java.lang.String commandId, java.util.Set<java.lang.String> configs) Method to update configs for a command in Genie.
retrofit2.Call<java.lang.Void>	updateTagsForCommand(java.lang.String commandId, java.util.Set<java.lang.String> tags) Method to update tags for a command in Genie.

Field Detail

COMMAND_URL_SUFFIX

static final java.lang.String COMMAND_URL_SUFFIX

Path to Commands.

See Also:

Constant Field Values

Method Detail

createCommand

@POST(value="/api/v3/commands")
retrofit2.Call<java.lang.Void> createCommand(@Body
                                                                             Command command)

Method to create a command in Genie.

Parameters:

command - The command object.

Returns:

A callable object.

updateCommand

@PUT(value="/api/v3/commands/{id}")
retrofit2.Call<java.lang.Void> updateCommand(@Path(value="id")
                                                                                 java.lang.String commandId,
                                                                                 @Body
                                                                                 Command command)

Method to update a command in Genie.

Parameters:

commandId - The id of the command to update.

command - The command object.

Returns:

A callable object.

getCommands

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

Method to get all commands from Genie filtered based on query params.

Parameters:

name - The name of the commands.

user - The user who created the command.

statusList - The list of Command statuses.

tagList - The list of tags.

Returns:

A callable object.

getCommand

@GET(value="/api/v3/commands/{id}")
retrofit2.Call<Command> getCommand(@Path(value="id")
                                                                       java.lang.String commandId)

Method to fetch a single job from Genie.

Parameters:

commandId - The id of the command to get.

Returns:

A callable object.

deleteCommand

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

Method to delete a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.

deleteAllCommands

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

Method to delete all commands in Genie.

Returns:

A callable object.

patchCommand

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

Patch a command using JSON Patch.

Parameters:

commandId - The id of the command to patch

patch - The JSON Patch instructions

Returns:

A callable object.

getApplicationsForCommand

@GET(value="/api/v3/commands/{id}/applications")
retrofit2.Call<java.util.List<Application>> getApplicationsForCommand(@Path(value="id")
                                                                                                                       java.lang.String commandId)

Method to get applications for a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.

getClustersForCommand

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

Method to get clusters for a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.

addApplicationsToCommand

@POST(value="/api/v3/commands/{id}/applications")
retrofit2.Call<java.lang.Void> addApplicationsToCommand(@Path(value="id")
                                                                                                          java.lang.String commandId,
                                                                                                          @Body
                                                                                                          java.util.List<java.lang.String> applicationIds)

Method to add applications to a command in Genie.

Parameters:

commandId - The id of the command..

applicationIds - The application Ids to be added.

Returns:

A callable object.

setApplicationsForCommand

@PUT(value="/api/v3/commands/{id}/applications")
retrofit2.Call<java.lang.Void> setApplicationsForCommand(@Path(value="id")
                                                                                                          java.lang.String commandId,
                                                                                                          @Body
                                                                                                          java.util.List<java.lang.String> applicationIds)

Method to override and set applications for a command in Genie.

Parameters:

commandId - The id of the command..

applicationIds - The application Ids to be added.

Returns:

A callable object.

removeApplicationForCommand

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

Method to delete a application for a command in Genie.

Parameters:

commandId - The id of the command.

applicationId - The application to delete.

Returns:

A callable object.

removeAllApplicationsForCommand

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

Method to delete all applications for a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.

getConfigsForCommand

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

Method to get configs for a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.

addConfigsToCommand

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

Method to add configs to a command in Genie.

Parameters:

commandId - The id of the command..

configs - The configs to be added.

Returns:

A callable object.

updateConfigsForCommand

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

Method to update configs for a command in Genie.

Parameters:

commandId - The id of the command..

configs - The configs to be added.

Returns:

A callable object.

removeAllConfigsForCommand

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

Method to delete all configs for a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.

getTagsForCommand

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

Method to get tags for a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.

addTagsToCommand

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

Method to add tags to a command in Genie.

Parameters:

commandId - The id of the command..

tags - The tags to be added.

Returns:

A callable object.

updateTagsForCommand

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

Method to update tags for a command in Genie.

Parameters:

commandId - The id of the command..

tags - The tags to be added.

Returns:

A callable object.

removeTagForCommand

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

Method to delete a tag for a command in Genie.

Parameters:

commandId - The id of the command.

tag - The tag to delete.

Returns:

A callable object.

removeAllTagsForCommand

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

Method to delete all tags for a command in Genie.

Parameters:

commandId - The id of the command.

Returns:

A callable object.