com.netflix.genie.client.apis

Interface ApplicationService

public interface ApplicationService

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

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_URL_SUFFIX Path to Applications.

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<java.lang.Void>	addConfigsToApplication(java.lang.String applicationId, java.util.Set<java.lang.String> configs) Method to add configs to a application in Genie.
retrofit2.Call<java.lang.Void>	addDependenciesToApplication(java.lang.String applicationId, java.util.Set<java.lang.String> dependencies) Method to add dependencies to a application in Genie.
retrofit2.Call<java.lang.Void>	addTagsToApplication(java.lang.String applicationId, java.util.Set<java.lang.String> tags) Method to add tags to a application in Genie.
retrofit2.Call<java.lang.Void>	createApplication(Application application) Method to create a application in Genie.
retrofit2.Call<java.lang.Void>	deleteAllApplications() Method to delete all applications in Genie.
retrofit2.Call<java.lang.Void>	deleteApplication(java.lang.String applicationId) Method to delete a application in Genie.
retrofit2.Call<Application>	getApplication(java.lang.String applicationId) Method to fetch a single job from Genie.
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode>	getApplications(java.lang.String name, java.lang.String user, java.util.List<java.lang.String> statusList, java.util.List<java.lang.String> tagList, java.lang.String type, java.lang.Integer size, java.lang.String sort, java.lang.Integer page) Method to get all applications from Genie.
retrofit2.Call<java.util.List<Command>>	getCommandsForApplication(java.lang.String applicationId) Method to get commmands for a application in Genie.
retrofit2.Call<java.util.Set<java.lang.String>>	getConfigsForApplication(java.lang.String applicationId) Method to get configs for a application in Genie.
retrofit2.Call<java.util.Set<java.lang.String>>	getDependenciesForApplication(java.lang.String applicationId) Method to get dependency files for a application in Genie.
retrofit2.Call<java.util.Set<java.lang.String>>	getTagsForApplication(java.lang.String applicationId) Method to get tags for a application in Genie.
retrofit2.Call<java.lang.Void>	patchApplication(java.lang.String applicationId, com.github.fge.jsonpatch.JsonPatch patch) Patch a application using JSON Patch.
retrofit2.Call<java.lang.Void>	removeAllConfigsForApplication(java.lang.String applicationId) Method to delete all configs for a application in Genie.
retrofit2.Call<java.lang.Void>	removeAllDependenciesForApplication(java.lang.String applicationId) Method to delete all dependencies for a application in Genie.
retrofit2.Call<java.lang.Void>	removeAllTagsForApplication(java.lang.String applicationId) Method to delete all tags for a application in Genie.
retrofit2.Call<java.lang.Void>	removeTagForApplication(java.lang.String applicationId, java.lang.String tag) Method to delete a tag for a application in Genie.
retrofit2.Call<java.lang.Void>	updateApplication(java.lang.String applicationId, Application application) Method to update a application in Genie.
retrofit2.Call<java.lang.Void>	updateConfigsForApplication(java.lang.String applicationId, java.util.Set<java.lang.String> configs) Method to update configs for a application in Genie.
retrofit2.Call<java.lang.Void>	updateDependenciesForApplication(java.lang.String applicationId, java.util.Set<java.lang.String> dependencies) Method to update dependencies for a application in Genie.
retrofit2.Call<java.lang.Void>	updateTagsForApplication(java.lang.String applicationId, java.util.Set<java.lang.String> tags) Method to update tags for a application in Genie.

Field Detail

APPLICATION_URL_SUFFIX

static final java.lang.String APPLICATION_URL_SUFFIX

Path to Applications.

See Also:

Constant Field Values

Method Detail

createApplication

@POST(value="/api/v3/applications")
retrofit2.Call<java.lang.Void> createApplication(@Body
                                                                                     Application application)

Method to create a application in Genie.

Parameters:

application - The application object.

Returns:

A callable object.

updateApplication

@PUT(value="/api/v3/applications/{id}")
retrofit2.Call<java.lang.Void> updateApplication(@Path(value="id")
                                                                                         java.lang.String applicationId,
                                                                                         @Body
                                                                                         Application application)

Method to update a application in Genie.

Parameters:

applicationId - The id of the application to update.

application - The application object.

Returns:

A callable object.

getApplications

@GET(value="/api/v3/applications")
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode> getApplications(@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,
                                                                                                           @Query(value="type")
                                                                                                           java.lang.String type,
                                                                                                           @Query(value="size")
                                                                                                           java.lang.Integer size,
                                                                                                           @Query(value="sort")
                                                                                                           java.lang.String sort,
                                                                                                           @Query(value="page")
                                                                                                           java.lang.Integer page)

Method to get all applications from Genie.

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.

type - The type of the application.

size - The maximum number of results in the page

sort - The sort order

page - The page index

Returns:

A callable object.

getApplication

@GET(value="/api/v3/applications/{id}")
retrofit2.Call<Application> getApplication(@Path(value="id")
                                                                                   java.lang.String applicationId)

Method to fetch a single job from Genie.

Parameters:

applicationId - The id of the application to get.

Returns:

A callable object.

deleteApplication

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

Method to delete a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.

deleteAllApplications

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

Method to delete all applications in Genie.

Returns:

A callable object.

patchApplication

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

Patch a application using JSON Patch.

Parameters:

applicationId - The id of the application to patch

patch - The JSON Patch instructions

Returns:

A callable object.

getCommandsForApplication

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

Method to get commmands for a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.

getDependenciesForApplication

@GET(value="/api/v3/applications/{id}/dependencies")
retrofit2.Call<java.util.Set<java.lang.String>> getDependenciesForApplication(@Path(value="id")
                                                                                                                                   java.lang.String applicationId)

Method to get dependency files for a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.

addDependenciesToApplication

@POST(value="/api/v3/applications/{id}/dependencies")
retrofit2.Call<java.lang.Void> addDependenciesToApplication(@Path(value="id")
                                                                                                                  java.lang.String applicationId,
                                                                                                                  @Body
                                                                                                                  java.util.Set<java.lang.String> dependencies)

Method to add dependencies to a application in Genie.

Parameters:

applicationId - The id of the application..

dependencies - The dependencies to be added.

Returns:

A callable object.

updateDependenciesForApplication

@PUT(value="/api/v3/applications/{id}/dependencies")
retrofit2.Call<java.lang.Void> updateDependenciesForApplication(@Path(value="id")
                                                                                                                     java.lang.String applicationId,
                                                                                                                     @Body
                                                                                                                     java.util.Set<java.lang.String> dependencies)

Method to update dependencies for a application in Genie.

Parameters:

applicationId - The id of the application..

dependencies - The dependencies to be added.

Returns:

A callable object.

removeAllDependenciesForApplication

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

Method to delete all dependencies for a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.

getConfigsForApplication

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

Method to get configs for a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.

addConfigsToApplication

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

Method to add configs to a application in Genie.

Parameters:

applicationId - The id of the application..

configs - The configs to be added.

Returns:

A callable object.

updateConfigsForApplication

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

Method to update configs for a application in Genie.

Parameters:

applicationId - The id of the application..

configs - The configs to be added.

Returns:

A callable object.

removeAllConfigsForApplication

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

Method to delete all configs for a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.

getTagsForApplication

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

Method to get tags for a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.

addTagsToApplication

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

Method to add tags to a application in Genie.

Parameters:

applicationId - The id of the application..

tags - The tags to be added.

Returns:

A callable object.

updateTagsForApplication

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

Method to update tags for a application in Genie.

Parameters:

applicationId - The id of the application..

tags - The tags to be added.

Returns:

A callable object.

removeTagForApplication

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

Method to delete a tag for a application in Genie.

Parameters:

applicationId - The id of the application.

tag - The tag to delete.

Returns:

A callable object.

removeAllTagsForApplication

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

Method to delete all tags for a application in Genie.

Parameters:

applicationId - The id of the application.

Returns:

A callable object.