org.graylog2.rest.resources.search

Class KeywordSearchResource

java.lang.Object

org.graylog2.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

Author:

Lennart Koopmann

Field Summary

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

indexer

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

objectMapper, serverStatus, userService

Constructor Summary

Constructors

Constructor and Description
KeywordSearchResource(Indexer indexer)

Method Summary

Methods

Modifier and Type	Method and Description
String	fieldHistogramKeyword(String query, String field, String interval, String keyword, String filter)
String	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)
String	statsKeyword(String field, String query, String keyword, String filter)
String	termsKeyword(String field, String query, int size, String keyword, String filter)
String	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

buildFieldStatsResult, buildHistogramResult, buildSearchResponse, buildSorting, buildTermsResult, buildTermsStatsResult, checkQuery, checkQueryAndField, checkQueryAndInterval, checkQueryAndKeyword, checkSearchPermission, checkStringSet, checkTermsStatsFields, createRequestExceptionForParseFailure, createScrollChunkProducer, fieldHistogram, fieldStats, fieldStats, parseFields, parseOptionalFields, validateInterval

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

buildHistogramMap, buildMeterMap, buildTimerMap, bytesToValueMap, checkPermission, checkPermission, getCurrentUser, getSubject, guessContentType, isPermitted, isPermitted, json, loadObjectId, page, restrictToMaster, 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(Indexer indexer)

Method Detail

searchKeyword

@GET
@Produces(value="application/json")
public SearchResponse searchKeyword(@QueryParam(value="query")
                                        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,
                                        @QueryParam(value="sort")
                                        String sort)

searchKeywordChunked

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

termsKeyword

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

termsStatsRelative

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

Throws:

IndexHelper.InvalidRangeFormatException

statsKeyword

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

fieldHistogramKeyword

@GET
@Path(value="/fieldhistogram")
@Produces(value="application/json")
public String fieldHistogramKeyword(@QueryParam(value="query")
                                             String query,
                                             @QueryParam(value="field")
                                             String field,
                                             @QueryParam(value="interval")
                                             String interval,
                                             @QueryParam(value="keyword")
                                             String keyword,
                                             @QueryParam(value="filter")
                                             String filter)