org.gcube.rest.index.common.apis

Interface IndexServiceAPI

All Superinterfaces:

org.gcube.rest.commons.resourceawareservice.ResourceAwareServiceRestAPI

public interface IndexServiceAPI
extends org.gcube.rest.commons.resourceawareservice.ResourceAwareServiceRestAPI

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	activateIndex(String scope, String resourceID, String indexName)
javax.ws.rs.core.Response	clustering(String scope, String resourceID, String queryString, String queryHint, Integer clustersCount, String urlField, List<String> titleFields, List<String> contentFields, List<String> languageFields, String algorithm, Integer searchHits, Set<String> sids, Boolean useRR, Boolean pretty)
javax.ws.rs.core.Response	collectionCount(String scope, String resourceID, String collectionID)
javax.ws.rs.core.Response	collectionsOfIndex(String scope, String resourceID, String indexName)
javax.ws.rs.core.Response	deactivateIndex(String scope, String resourceID, String indexName)
javax.ws.rs.core.Response	deleteDocuments(String scope, String resourceID, List<String> docIDs)
javax.ws.rs.core.Response	deleteIndex(String scope, String resourceID, String indexName)
javax.ws.rs.core.Response	destroyCluster(String scope, String resourceID)
javax.ws.rs.core.Response	feedLocator(String scope, String resourceID, String resultSetLocation, String indexName, Boolean activate, Set<String> sids, Boolean block)
javax.ws.rs.core.Response	flush(String scope, String resourceID)
javax.ws.rs.core.Response	frequentTerms(String scope, String resourceID, String queryString, Integer maxTerms, Set<String> sids, Boolean useRR, Boolean pretty)
javax.ws.rs.core.Response	indicesOfCollection(String scope, String resourceID, String collectionID)
javax.ws.rs.core.Response	query(String scope, String resourceID, String queryString, Integer from, Integer count, Set<String> sids, Boolean useRR, Boolean result, Boolean stream, Boolean pretty)
javax.ws.rs.core.Response	rebuildMetaIndex(String scope, String resourceID)
javax.ws.rs.core.Response	refresh(String scope, String resourceID)
javax.ws.rs.core.Response	setCollectionsAndFields(String scope, String resourceID, List<String> collections, List<String> fields)
javax.ws.rs.core.Response	shutdown(String scope, String resourceID, Boolean delete)

Methods inherited from interface org.gcube.rest.commons.resourceawareservice.ResourceAwareServiceRestAPI

createResourceREST, destroyResourceREST, filterResourcesREST, getResourceREST, listResourcesREST

Method Detail

feedLocator

@GET
@Path(value="/{id}/feedLocator")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response feedLocator(@HeaderParam(value="gcube-scope")
                                                      String scope,
                                                      @PathParam(value="id")
                                                      String resourceID,
                                                      @QueryParam(value="rsuri")
                                                      String resultSetLocation,
                                                      @QueryParam(value="indexName")
                                                      String indexName,
                                                      @DefaultValue(value="false")@QueryParam(value="activate")
                                                      Boolean activate,
                                                      @QueryParam(value="sids")
                                                      Set<String> sids,
                                                      @DefaultValue(value="false")@QueryParam(value="block")
                                                      Boolean block)

query

@POST
@Path(value="/{id}/query")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response query(@HeaderParam(value="gcube-scope")
                                                 String scope,
                                                 @PathParam(value="id")
                                                 String resourceID,
                                                 @FormParam(value="queryString")
                                                 String queryString,
                                                 @DefaultValue(value="0")@FormParam(value="from")
                                                 Integer from,
                                                 @DefaultValue(value="-1")@FormParam(value="count")
                                                 Integer count,
                                                 @FormParam(value="sids")
                                                 Set<String> sids,
                                                 @DefaultValue(value="true")@FormParam(value="useRR")
                                                 Boolean useRR,
                                                 @DefaultValue(value="false")@FormParam(value="result")
                                                 Boolean result,
                                                 @DefaultValue(value="false")@FormParam(value="stream")
                                                 Boolean stream,
                                                 @DefaultValue(value="false")@FormParam(value="pretty")
                                                 Boolean pretty)

clustering

@GET
@Path(value="/{id}/clustering")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response clustering(@HeaderParam(value="gcube-scope")
                                                     String scope,
                                                     @PathParam(value="id")
                                                     String resourceID,
                                                     @QueryParam(value="queryString")
                                                     String queryString,
                                                     @DefaultValue(value="")@QueryParam(value="queryHint")
                                                     String queryHint,
                                                     @QueryParam(value="clustersCount")
                                                     Integer clustersCount,
                                                     @QueryParam(value="urlField")
                                                     String urlField,
                                                     @QueryParam(value="titleFields")
                                                     List<String> titleFields,
                                                     @QueryParam(value="contentFields")
                                                     List<String> contentFields,
                                                     @QueryParam(value="languageFields")
                                                     List<String> languageFields,
                                                     @DefaultValue(value="kmeans")@QueryParam(value="algorithm")
                                                     String algorithm,
                                                     @DefaultValue(value="100")@QueryParam(value="searchHits")
                                                     Integer searchHits,
                                                     @QueryParam(value="sids")
                                                     Set<String> sids,
                                                     @DefaultValue(value="true")@QueryParam(value="useRR")
                                                     Boolean useRR,
                                                     @DefaultValue(value="false")@QueryParam(value="pretty")
                                                     Boolean pretty)

frequentTerms

@GET
@Path(value="/{id}/frequentTerms")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response frequentTerms(@HeaderParam(value="gcube-scope")
                                                        String scope,
                                                        @PathParam(value="id")
                                                        String resourceID,
                                                        @QueryParam(value="queryString")
                                                        String queryString,
                                                        @DefaultValue(value="0")@QueryParam(value="maxTerms")
                                                        Integer maxTerms,
                                                        @QueryParam(value="sids")
                                                        Set<String> sids,
                                                        @DefaultValue(value="true")@QueryParam(value="useRR")
                                                        Boolean useRR,
                                                        @DefaultValue(value="false")@QueryParam(value="pretty")
                                                        Boolean pretty)

refresh

@GET
@Path(value="/{id}/refresh")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response refresh(@HeaderParam(value="gcube-scope")
                                                  String scope,
                                                  @PathParam(value="id")
                                                  String resourceID)

rebuildMetaIndex

@GET
@Path(value="/{id}/rebuildMetaIndex")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response rebuildMetaIndex(@HeaderParam(value="gcube-scope")
                                                           String scope,
                                                           @PathParam(value="id")
                                                           String resourceID)

activateIndex

@GET
@Path(value="/{id}/activateIndex")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response activateIndex(@HeaderParam(value="gcube-scope")
                                                        String scope,
                                                        @PathParam(value="id")
                                                        String resourceID,
                                                        @QueryParam(value="indexName")
                                                        String indexName)

deactivateIndex

@GET
@Path(value="/{id}/deactivateIndex")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response deactivateIndex(@HeaderParam(value="gcube-scope")
                                                          String scope,
                                                          @PathParam(value="id")
                                                          String resourceID,
                                                          @QueryParam(value="indexName")
                                                          String indexName)

deleteDocuments

@GET
@Path(value="/{id}/deleteDocuments")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response deleteDocuments(@HeaderParam(value="gcube-scope")
                                                          String scope,
                                                          @PathParam(value="id")
                                                          String resourceID,
                                                          @QueryParam(value="docIDs")
                                                          List<String> docIDs)

deleteIndex

@GET
@Path(value="/{id}/deleteIndex")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response deleteIndex(@HeaderParam(value="gcube-scope")
                                                      String scope,
                                                      @PathParam(value="id")
                                                      String resourceID,
                                                      @QueryParam(value="indexName")
                                                      String indexName)

collectionCount

@GET
@Path(value="/{id}/collectionCount")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response collectionCount(@HeaderParam(value="gcube-scope")
                                                          String scope,
                                                          @PathParam(value="id")
                                                          String resourceID,
                                                          @QueryParam(value="collectionID")
                                                          String collectionID)

collectionsOfIndex

@GET
@Path(value="/{id}/collectionsOfIndex")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response collectionsOfIndex(@HeaderParam(value="gcube-scope")
                                                             String scope,
                                                             @PathParam(value="id")
                                                             String resourceID,
                                                             @QueryParam(value="indexName")
                                                             String indexName)

indicesOfCollection

@GET
@Path(value="/{id}/indicesOfCollection")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response indicesOfCollection(@HeaderParam(value="gcube-scope")
                                                              String scope,
                                                              @PathParam(value="id")
                                                              String resourceID,
                                                              @QueryParam(value="collectionID")
                                                              String collectionID)

setCollectionsAndFields

@POST
@Path(value="/{id}/setCollectionsAndFields")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response setCollectionsAndFields(@HeaderParam(value="gcube-scope")
                                                                   String scope,
                                                                   @PathParam(value="id")
                                                                   String resourceID,
                                                                   @FormParam(value="collections")
                                                                   List<String> collections,
                                                                   @FormParam(value="fields")
                                                                   List<String> fields)

shutdown

@GET
@Path(value="/{id}/shutdown")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response shutdown(@HeaderParam(value="gcube-scope")
                                                   String scope,
                                                   @PathParam(value="id")
                                                   String resourceID,
                                                   @DefaultValue(value="false")@QueryParam(value="delete")
                                                   Boolean delete)

destroyCluster

@GET
@Path(value="/{id}/destroyCluster")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response destroyCluster(@HeaderParam(value="gcube-scope")
                                                         String scope,
                                                         @PathParam(value="id")
                                                         String resourceID)

flush

@GET
@Path(value="/{id}/flush")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response flush(@HeaderParam(value="gcube-scope")
                                                String scope,
                                                @PathParam(value="id")
                                                String resourceID)