org.graylog2.rest.resources.search

Class KeywordSearchResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.search.SearchResource

org.graylog2.rest.resources.search.KeywordSearchResource

@Path(value="/search/universal/keyword")
public class KeywordSearchResource
extends SearchResource

Field Summary

Fields inherited from class org.graylog2.rest.resources.search.SearchResource

searches

Fields inherited from class org.graylog2.shared.rest.resources.RestResource

objectMapper, userService

Constructor Summary

Constructors

Constructor and Description
KeywordSearchResource(Searches searches, ClusterConfigService clusterConfigService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportSearchKeywordChunked(String query, String keyword, int limit, int offset, String filter, String fields)
HistogramResult	fieldHistogramKeyword(String query, String field, String interval, String keyword, String filter, boolean includeCardinality)
HistogramResult	histogramKeyword(String query, String interval, String keyword, String filter)
SearchResponse	searchKeyword(String query, String keyword, int limit, int offset, String filter, String fields, String sort)
org.glassfish.jersey.server.ChunkedOutput<ScrollResult.ScrollChunk>	searchKeywordChunked(String query, String keyword, int limit, int offset, String filter, String fields)
FieldStatsResult	statsKeyword(String field, String query, String keyword, String filter)
TermsResult	termsKeyword(String field, String query, int size, String keyword, String filter)
TermsStatsResult	termsStatsRelative(String keyField, String valueField, String order, String query, int size, String keyword, String filter)

Methods inherited from class org.graylog2.rest.resources.search.SearchResource

buildChunkedOutput, buildFieldStatsResult, buildHistogramResult, buildSearchResponse, buildSorting, buildTermsResult, buildTermsStatsResult, checkSearchPermission, createRequestExceptionForParseFailure, createScrollChunkProducer, fieldHistogram, fieldStats, indexRangeListToValueList, parseFields, parseOptionalFields, restrictTimeRange, resultMessageListtoValueList, validateInterval

Methods inherited from class org.graylog2.shared.rest.resources.RestResource

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordSearchResource

@Inject
public KeywordSearchResource(Searches searches,
                                     ClusterConfigService clusterConfigService)

Method Detail

searchKeyword

@GET
 @Timed
 @Produces(value="application/json")
public SearchResponse searchKeyword(@QueryParam(value="query") @NotEmpty
                                                                                      String query,
                                                                                      @QueryParam(value="keyword") @NotEmpty
                                                                                      String keyword,
                                                                                      @QueryParam(value="limit")
                                                                                      int limit,
                                                                                      @QueryParam(value="offset")
                                                                                      int offset,
                                                                                      @QueryParam(value="filter")
                                                                                      String filter,
                                                                                      @QueryParam(value="fields")
                                                                                      String fields,
                                                                                      @QueryParam(value="sort")
                                                                                      String sort)

searchKeywordChunked

@GET
 @Timed
 @Produces(value="text/csv")
public org.glassfish.jersey.server.ChunkedOutput<ScrollResult.ScrollChunk> searchKeywordChunked(@QueryParam(value="query") @NotEmpty
                                                                                                                                          String query,
                                                                                                                                          @QueryParam(value="keyword")
                                                                                                                                          String keyword,
                                                                                                                                          @QueryParam(value="limit")
                                                                                                                                          int limit,
                                                                                                                                          @QueryParam(value="offset")
                                                                                                                                          int offset,
                                                                                                                                          @QueryParam(value="filter")
                                                                                                                                          String filter,
                                                                                                                                          @QueryParam(value="fields")
                                                                                                                                          String fields)

exportSearchKeywordChunked

@GET
 @Path(value="/export")
 @Timed
 @Produces(value="text/csv")
public javax.ws.rs.core.Response exportSearchKeywordChunked(@QueryParam(value="query") @NotEmpty
                                                                                                                              String query,
                                                                                                                              @QueryParam(value="keyword")
                                                                                                                              String keyword,
                                                                                                                              @QueryParam(value="limit")
                                                                                                                              int limit,
                                                                                                                              @QueryParam(value="offset")
                                                                                                                              int offset,
                                                                                                                              @QueryParam(value="filter")
                                                                                                                              String filter,
                                                                                                                              @QueryParam(value="fields")
                                                                                                                              String fields)

histogramKeyword

@GET
 @Path(value="/histogram")
 @Timed
 @Produces(value="application/json")
public HistogramResult histogramKeyword(@QueryParam(value="query") @NotEmpty
                                                                                                                     String query,
                                                                                                                     @QueryParam(value="interval") @NotEmpty
                                                                                                                     String interval,
                                                                                                                     @QueryParam(value="keyword")
                                                                                                                     String keyword,
                                                                                                                     @QueryParam(value="filter")
                                                                                                                     String filter)

termsKeyword

@GET
 @Path(value="/terms")
 @Timed
 @Produces(value="application/json")
public TermsResult termsKeyword(@QueryParam(value="field") @NotEmpty
                                                                                                         String field,
                                                                                                         @QueryParam(value="query") @NotEmpty
                                                                                                         String query,
                                                                                                         @QueryParam(value="size")
                                                                                                         int size,
                                                                                                         @QueryParam(value="keyword")
                                                                                                         String keyword,
                                                                                                         @QueryParam(value="filter")
                                                                                                         String filter)

termsStatsRelative

@GET
 @Path(value="/termsstats")
 @Timed
 @Produces(value="application/json")
public TermsStatsResult termsStatsRelative(@QueryParam(value="key_field") @NotEmpty
                                                                                                                         String keyField,
                                                                                                                         @QueryParam(value="value_field") @NotEmpty
                                                                                                                         String valueField,
                                                                                                                         @QueryParam(value="order") @NotEmpty
                                                                                                                         String order,
                                                                                                                         @QueryParam(value="query") @NotEmpty
                                                                                                                         String query,
                                                                                                                         @QueryParam(value="size")
                                                                                                                         int size,
                                                                                                                         @QueryParam(value="keyword")
                                                                                                                         String keyword,
                                                                                                                         @QueryParam(value="filter")
                                                                                                                         String filter)

statsKeyword

@GET
 @Path(value="/stats")
 @Timed
 @Produces(value="application/json")
public FieldStatsResult statsKeyword(@QueryParam(value="field") @NotEmpty
                                                                                                              String field,
                                                                                                              @QueryParam(value="query") @NotEmpty
                                                                                                              String query,
                                                                                                              @QueryParam(value="keyword")
                                                                                                              String keyword,
                                                                                                              @QueryParam(value="filter")
                                                                                                              String filter)

fieldHistogramKeyword

@GET
 @Path(value="/fieldhistogram")
 @Timed
 @Produces(value="application/json")
public HistogramResult fieldHistogramKeyword(@QueryParam(value="query") @NotEmpty
                                                                                                                               String query,
                                                                                                                               @QueryParam(value="field") @NotEmpty
                                                                                                                               String field,
                                                                                                                               @QueryParam(value="interval") @NotEmpty
                                                                                                                               String interval,
                                                                                                                               @QueryParam(value="keyword")
                                                                                                                               String keyword,
                                                                                                                               @QueryParam(value="filter")
                                                                                                                               String filter,
                                                                                                                               @QueryParam(value="cardinality")
                                                                                                                               boolean includeCardinality)