Package 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

@RequiresAuthentication
@Path("/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

configuration, userService

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	exportSearchRelativeChunked(@NotEmpty String query, @javax.validation.constraints.PositiveOrZero int range, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)
SearchResponse	searchRelative(@NotEmpty String query, @javax.validation.constraints.PositiveOrZero int range, int limit, int offset, String filter, String fields, String sort, boolean decorate, SearchUser searchUser)
org.glassfish.jersey.server.ChunkedOutput<ResultChunk>	searchRelativeChunked(@NotEmpty String query, @javax.validation.constraints.PositiveOrZero int range, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)

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

buildChunkedOutput, buildSearchResponse, buildSearchResponse, buildSorting, buildSortOrder, checkSearchPermission, createScrollChunkProducer, createSearch, extractSearchResponse, indexRangeListToValueList, parseFields, parseOptionalFields, restrictTimeRange, resultMessageListtoValueList, search

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 Details

RelativeSearchResource

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

Method Details

searchRelative

@GET
@Timed
@Produces("application/json")
public SearchResponse searchRelative(@QueryParam("query") @NotEmpty
 @NotEmpty String query,
 @QueryParam("range") @PositiveOrZero
 @javax.validation.constraints.PositiveOrZero int range,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset,
 @QueryParam("filter")
 String filter,
 @QueryParam("fields")
 String fields,
 @QueryParam("sort")
 String sort,
 @QueryParam("decorate") @DefaultValue("true")
 boolean decorate,
 @Context
 SearchUser searchUser)

searchRelativeChunked

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

exportSearchRelativeChunked

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