Package org.openmetadata.service.resources.search

Class SearchResource

java.lang.Object

org.openmetadata.service.resources.search.SearchResource

@Path("/v1/search")
@Produces("application/json")
public class SearchResource
extends Object

Constructor Summary

Constructors

Constructor	Description
SearchResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	aggregate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String index, String fieldName, String value, String query, int size, String deleted)
javax.ws.rs.core.Response	getElasticSearchMappingSchema(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String entityType)
void	initialize(OpenMetadataApplicationConfig config)
javax.ws.rs.core.Response	reindexAllJobLastStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
javax.ws.rs.core.Response	reindexAllJobs(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
javax.ws.rs.core.Response	reindexEntities(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateEventPublisherJob createRequest)
javax.ws.rs.core.Response	reindexJobWithId(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	reindexLatestJob(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
javax.ws.rs.core.Response	search(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String query, String index, boolean deleted, int from, int size, String sortFieldParam, String sortOrder, boolean trackTotalHits, String queryFilter, String postFilter, boolean fetchSource, List<String> includeSourceFields)
javax.ws.rs.core.Response	searchBySourceUrl(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String sourceUrl)
javax.ws.rs.core.Response	stopReindexJob(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	suggest(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String query, String index, String fieldName, int size, boolean fetchSource, List<String> includeSourceFields, boolean deleted)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResource

public SearchResource(CollectionDAO dao,
                      Authorizer authorizer)

Method Detail

initialize

public void initialize(OpenMetadataApplicationConfig config)

search

@GET
@Path("/query")
public javax.ws.rs.core.Response search(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @DefaultValue("*") @QueryParam("q")
                                        String query,
                                        @DefaultValue("table_search_index") @QueryParam("index")
                                        String index,
                                        @DefaultValue("false") @QueryParam("deleted") @Deprecated(forRemoval=true)
                                        boolean deleted,
                                        @DefaultValue("0") @QueryParam("from")
                                        int from,
                                        @DefaultValue("10") @QueryParam("size")
                                        int size,
                                        @DefaultValue("_score") @QueryParam("sort_field")
                                        String sortFieldParam,
                                        @DefaultValue("desc") @QueryParam("sort_order")
                                        String sortOrder,
                                        @DefaultValue("false") @QueryParam("track_total_hits")
                                        boolean trackTotalHits,
                                        @QueryParam("query_filter")
                                        String queryFilter,
                                        @QueryParam("post_filter")
                                        String postFilter,
                                        @DefaultValue("true") @QueryParam("fetch_source")
                                        boolean fetchSource,
                                        @QueryParam("include_source_fields")
                                        List<String> includeSourceFields)
                                 throws IOException

Throws:

IOException

searchBySourceUrl

@GET
@Path("/sourceUrl")
public javax.ws.rs.core.Response searchBySourceUrl(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @Context
                                                   javax.ws.rs.core.SecurityContext securityContext,
                                                   @QueryParam("sourceUrl")
                                                   String sourceUrl)
                                            throws IOException

Throws:

IOException

suggest

@GET
@Path("/suggest")
public javax.ws.rs.core.Response suggest(@Context
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         @Context
                                         javax.ws.rs.core.SecurityContext securityContext,
                                         @QueryParam("q")
                                         String query,
                                         @DefaultValue("table_search_index") @QueryParam("index")
                                         String index,
                                         @DefaultValue("suggest") @QueryParam("field")
                                         String fieldName,
                                         @DefaultValue("10") @QueryParam("size")
                                         int size,
                                         @DefaultValue("true") @QueryParam("fetch_source")
                                         boolean fetchSource,
                                         @QueryParam("include_source_fields")
                                         List<String> includeSourceFields,
                                         @DefaultValue("false") @QueryParam("deleted")
                                         boolean deleted)
                                  throws IOException

Throws:

IOException

aggregate

@GET
@Path("/aggregate")
public javax.ws.rs.core.Response aggregate(@Context
                                           javax.ws.rs.core.UriInfo uriInfo,
                                           @Context
                                           javax.ws.rs.core.SecurityContext securityContext,
                                           @DefaultValue("table_search_index") @QueryParam("index")
                                           String index,
                                           @QueryParam("field")
                                           String fieldName,
                                           @DefaultValue("") @QueryParam("value")
                                           String value,
                                           @DefaultValue("*") @QueryParam("q")
                                           String query,
                                           @DefaultValue("10") @QueryParam("size")
                                           int size,
                                           @DefaultValue("false") @QueryParam("deleted")
                                           String deleted)
                                    throws IOException

Throws:

IOException

reindexLatestJob

@GET
@Path("/reindex/latest")
public javax.ws.rs.core.Response reindexLatestJob(@Context
                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                  @Context
                                                  javax.ws.rs.core.SecurityContext securityContext)

reindexAllJobLastStatus

@GET
@Path("/reindex/stream/status")
public javax.ws.rs.core.Response reindexAllJobLastStatus(@Context
                                                         javax.ws.rs.core.UriInfo uriInfo,
                                                         @Context
                                                         javax.ws.rs.core.SecurityContext securityContext)

reindexJobWithId

@GET
@Path("/reindex/{jobId}")
public javax.ws.rs.core.Response reindexJobWithId(@Context
                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                  @Context
                                                  javax.ws.rs.core.SecurityContext securityContext,
                                                  @PathParam("jobId")
                                                  UUID id)

getElasticSearchMappingSchema

@GET
@Path("/mappings")
public javax.ws.rs.core.Response getElasticSearchMappingSchema(@Context
                                                               javax.ws.rs.core.UriInfo uriInfo,
                                                               @Context
                                                               javax.ws.rs.core.SecurityContext securityContext,
                                                               @QueryParam("entityType")
                                                               String entityType)

reindexAllJobs

@GET
@Path("/reindex")
public javax.ws.rs.core.Response reindexAllJobs(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext)

reindexEntities

@POST
@Path("/reindex")
public javax.ws.rs.core.Response reindexEntities(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 @Context
                                                 javax.ws.rs.core.SecurityContext securityContext,
                                                 @Valid
                                                 @Valid CreateEventPublisherJob createRequest)

stopReindexJob

@PUT
@Path("/reindex/stop/{jobId}")
public javax.ws.rs.core.Response stopReindexJob(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext,
                                                @PathParam("jobId")
                                                UUID id)