SearchRequest

Properties

filter: Map<string,Object>;

ElasticSearch filter. Follows the syntax defined in the elastic search manual.

indices: string[];

List of indices to be searched.

page: Pagination;

Pagination information

query: Map<string,Object>;

ElasticSearch query. Follows the syntax defined in the elastic search manual.

requestId: string;

User field for traceability of requests. Synchronous SDK APIs use this field for you.

sort: SearchRequestSortField[];

Sort information

types: string[];

The document types to execute the search against. Defaults to be executed against all types.

Source

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
interface SearchRequest {

  /**
   * ElasticSearch filter. Follows the syntax defined in the elastic search manual.
   */
  filter: Map<string,Object>;

  /**
   * List of indices to be searched.
   */
  indices: string[];

  /**
   * Pagination information
   */
  page: Pagination;

  /**
   * ElasticSearch query. Follows the syntax defined in the elastic search manual.
   */
  query: Map<string,Object>;

  /**
   * User field for traceability of requests. Synchronous SDK APIs use this field for you.
   */
  requestId: string;

  /**
   * Sort information
   */
  sort: SearchRequestSortField[];

  /**
   * The document types to execute the search against. Defaults to be executed against all types.
   */
  types: string[];

}