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

DEFAULT_SCROLL_BATCH_SIZE, searches

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

configuration, userService

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportSearchKeywordChunked(@NotEmpty String query, @NotEmpty String keyword, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)
SearchResponse	searchKeyword(@NotEmpty String query, @NotEmpty String keyword, int limit, int offset, String filter, String fields, String sort, boolean decorate)
org.glassfish.jersey.server.ChunkedOutput<ScrollResult.ScrollChunk>	searchKeywordChunked(@NotEmpty String query, @NotEmpty String keyword, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)

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

buildChunkedOutput, buildSearchResponse, buildSorting, checkSearchPermission, createScrollChunkProducer, indexRangeListToValueList, parseFields, parseOptionalFields, restrictTimeRange, resultMessageListtoValueList

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

KeywordSearchResource

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

Method Detail

searchKeyword

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

searchKeywordChunked

@GET
 @Timed
 @Produces(value="text/csv")
public org.glassfish.jersey.server.ChunkedOutput<ScrollResult.ScrollChunk> searchKeywordChunked(@QueryParam(value="query") @NotEmpty
                                                                                                                                          @NotEmpty String query,
                                                                                                                                          @QueryParam(value="keyword") @NotEmpty
                                                                                                                                          @NotEmpty String keyword,
                                                                                                                                          @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)

exportSearchKeywordChunked

@GET
 @Path(value="/export")
 @Timed
 @Produces(value="text/csv")
public javax.ws.rs.core.Response exportSearchKeywordChunked(@QueryParam(value="query") @NotEmpty
                                                                                                                              @NotEmpty String query,
                                                                                                                              @QueryParam(value="keyword") @NotEmpty
                                                                                                                              @NotEmpty String keyword,
                                                                                                                              @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)