org.graylog2.rest.resources.search

Class RelativeSearchResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.search.SearchResource

org.graylog2.rest.resources.search.RelativeSearchResource

@Path(value="/search/universal/relative")
public class RelativeSearchResource
extends SearchResource

Field Summary

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

DEFAULT_SCROLL_BATCH_SIZE, searches

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

userService

Constructor Summary

Constructors

Constructor and Description
RelativeSearchResource(Searches searches, ClusterConfigService clusterConfigService, DecoratorProcessor decoratorProcessor)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportSearchRelativeChunked(@NotEmpty String query, @PositiveOrZero int range, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)
HistogramResult	fieldHistogramRelative(@NotEmpty String query, @NotEmpty String field, @NotEmpty String interval, @PositiveOrZero int range, String filter, boolean includeCardinality)
HistogramResult	histogramRelative(@NotEmpty String query, @NotEmpty String interval, @PositiveOrZero int range, String filter)
SearchResponse	searchRelative(@NotEmpty String query, @PositiveOrZero int range, int limit, int offset, String filter, String fields, String sort, boolean decorate)
org.glassfish.jersey.server.ChunkedOutput<ScrollResult.ScrollChunk>	searchRelativeChunked(@NotEmpty String query, @PositiveOrZero int range, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)
FieldStatsResult	statsRelative(@NotEmpty String field, @NotEmpty String query, @PositiveOrZero int range, String filter)
TermsHistogramResult	termsHistogramRelative(@NotEmpty String field, @NotEmpty String query, String stackedFieldsParam, @Min(value=1L) int size, @PositiveOrZero int range, String interval, String filter, String order)
TermsResult	termsRelative(@NotEmpty String field, @NotEmpty String query, String stackedFieldsParam, int size, @PositiveOrZero int range, String filter, String order)
TermsStatsResult	termsStatsRelative(@NotEmpty String keyField, @NotEmpty String valueField, @NotEmpty String order, @NotEmpty String query, int size, @PositiveOrZero int range, String filter)

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

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

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

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, 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

RelativeSearchResource

@Inject
public RelativeSearchResource(Searches searches,
                                      ClusterConfigService clusterConfigService,
                                      DecoratorProcessor decoratorProcessor)

Method Detail

searchRelative

@GET
 @Timed
 @Produces(value="application/json")
public SearchResponse searchRelative(@QueryParam(value="query") @NotEmpty
                                                                                       @NotEmpty String query,
                                                                                       @QueryParam(value="range") @PositiveOrZero
                                                                                       @PositiveOrZero int range,
                                                                                       @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,
                                                                                       @QueryParam(value="decorate") @DefaultValue(value="true")
                                                                                       boolean decorate)

searchRelativeChunked

@GET
 @Timed
 @Produces(value="text/csv")
public org.glassfish.jersey.server.ChunkedOutput<ScrollResult.ScrollChunk> searchRelativeChunked(@QueryParam(value="query") @NotEmpty
                                                                                                                                           @NotEmpty String query,
                                                                                                                                           @QueryParam(value="range") @PositiveOrZero
                                                                                                                                           @PositiveOrZero int range,
                                                                                                                                           @QueryParam(value="limit")
                                                                                                                                           int limit,
                                                                                                                                           @QueryParam(value="offset")
                                                                                                                                           int offset,
                                                                                                                                           @QueryParam(value="batch_size") @DefaultValue(value="500")
                                                                                                                                           int batchSize,
                                                                                                                                           @QueryParam(value="filter")
                                                                                                                                           String filter,
                                                                                                                                           @QueryParam(value="fields") @NotEmpty
                                                                                                                                           @NotEmpty String fields)

exportSearchRelativeChunked

@GET
 @Path(value="/export")
 @Timed
 @Produces(value="text/csv")
public javax.ws.rs.core.Response exportSearchRelativeChunked(@QueryParam(value="query") @NotEmpty
                                                                                                                               @NotEmpty String query,
                                                                                                                               @QueryParam(value="range") @PositiveOrZero
                                                                                                                               @PositiveOrZero int range,
                                                                                                                               @QueryParam(value="limit")
                                                                                                                               int limit,
                                                                                                                               @QueryParam(value="offset")
                                                                                                                               int offset,
                                                                                                                               @QueryParam(value="batch_size") @DefaultValue(value="500")
                                                                                                                               int batchSize,
                                                                                                                               @QueryParam(value="filter")
                                                                                                                               String filter,
                                                                                                                               @QueryParam(value="fields") @NotEmpty
                                                                                                                               @NotEmpty String fields)

termsRelative

@GET
 @Path(value="/terms")
 @Timed
 @Produces(value="application/json")
public TermsResult termsRelative(@QueryParam(value="field") @NotEmpty
                                                                                                          @NotEmpty String field,
                                                                                                          @QueryParam(value="query") @NotEmpty
                                                                                                          @NotEmpty String query,
                                                                                                          @QueryParam(value="stacked_fields")
                                                                                                          String stackedFieldsParam,
                                                                                                          @QueryParam(value="size")
                                                                                                          int size,
                                                                                                          @QueryParam(value="range") @PositiveOrZero
                                                                                                          @PositiveOrZero int range,
                                                                                                          @QueryParam(value="filter")
                                                                                                          String filter,
                                                                                                          @QueryParam(value="order")
                                                                                                          String order)

termsHistogramRelative

@GET
 @Path(value="/terms-histogram")
 @Timed
 @Produces(value="application/json")
public TermsHistogramResult termsHistogramRelative(@QueryParam(value="field") @NotEmpty
                                                                                                                                      @NotEmpty String field,
                                                                                                                                      @QueryParam(value="query") @NotEmpty
                                                                                                                                      @NotEmpty String query,
                                                                                                                                      @QueryParam(value="stacked_fields")
                                                                                                                                      String stackedFieldsParam,
                                                                                                                                      @QueryParam(value="size") @Min(value=1L)
                                                                                                                                      @Min(value=1L) int size,
                                                                                                                                      @QueryParam(value="range") @PositiveOrZero
                                                                                                                                      @PositiveOrZero int range,
                                                                                                                                      @QueryParam(value="interval")
                                                                                                                                      String interval,
                                                                                                                                      @QueryParam(value="filter")
                                                                                                                                      String filter,
                                                                                                                                      @QueryParam(value="order")
                                                                                                                                      String order)

termsStatsRelative

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

statsRelative

@GET
 @Path(value="/stats")
 @Timed
 @Produces(value="application/json")
public FieldStatsResult statsRelative(@QueryParam(value="field") @NotEmpty
                                                                                                               @NotEmpty String field,
                                                                                                               @QueryParam(value="query") @NotEmpty
                                                                                                               @NotEmpty String query,
                                                                                                               @QueryParam(value="range") @PositiveOrZero
                                                                                                               @PositiveOrZero int range,
                                                                                                               @QueryParam(value="filter")
                                                                                                               String filter)

histogramRelative

@GET
 @Path(value="/histogram")
 @Timed
 @Produces(value="application/json")
public HistogramResult histogramRelative(@QueryParam(value="query") @NotEmpty
                                                                                                                      @NotEmpty String query,
                                                                                                                      @QueryParam(value="interval") @NotEmpty
                                                                                                                      @NotEmpty String interval,
                                                                                                                      @QueryParam(value="range") @PositiveOrZero
                                                                                                                      @PositiveOrZero int range,
                                                                                                                      @QueryParam(value="filter")
                                                                                                                      String filter)

fieldHistogramRelative

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