Class SearchMvtRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.SearchMvtRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class SearchMvtRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchMvtRequest.Builder
Builder forSearchMvtRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<SearchMvtRequest>
_DESERIALIZER
Json deserializer forSearchMvtRequest
static Endpoint<SearchMvtRequest,SearchMvtResponse,ElasticsearchError>
ENDPOINT
Endpoint "search_mvt
". -
Constructor Summary
Constructors Constructor Description SearchMvtRequest(SearchMvtRequest.Builder builder)
SearchMvtRequest(java.util.function.Function<SearchMvtRequest.Builder,SearchMvtRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.util.Map<java.lang.String,Aggregation>
aggs()
Sub-aggregations for the geotile_grid.java.lang.Boolean
exactBounds()
If false, the meta layer’s feature is the bounding box of the tile.java.lang.Integer
extent()
Size, in pixels, of a side of the tile.java.lang.String
field()
Required - Field containing geospatial data to returnjava.util.List<java.lang.String>
fields()
Fields to return in thehits
layer.java.lang.Integer
gridPrecision()
Additional zoom levels available through the aggs layer.GridType
gridType()
Determines the geometry type for features in the aggs layer.java.util.List<java.lang.String>
index()
Required - Comma-separated list of data streams, indices, or aliases to searchQuery
query()
Query DSL used to filter documents for the search.java.util.Map<java.lang.String,RuntimeField>
runtimeMappings()
Defines one or more runtime fields in the search request.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupSearchMvtRequestDeserializer(DelegatingDeserializer<SearchMvtRequest.Builder> op)
java.lang.Integer
size()
Maximum number of features to return in the hits layer.java.util.List<jakarta.json.JsonValue>
sort()
Sorts features in the hits layer.int
x()
Required - X coordinate for the vector tile to searchint
y()
Required - Y coordinate for the vector tile to searchint
zoom()
Required - Zoom level for the vector tile to searchMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forSearchMvtRequest
-
ENDPOINT
Endpoint "search_mvt
".
-
-
Constructor Details
-
SearchMvtRequest
-
SearchMvtRequest
public SearchMvtRequest(java.util.function.Function<SearchMvtRequest.Builder,SearchMvtRequest.Builder> fn)
-
-
Method Details
-
index
public java.util.List<java.lang.String> index()Required - Comma-separated list of data streams, indices, or aliases to searchAPI name:
index
-
field
public java.lang.String field()Required - Field containing geospatial data to returnAPI name:
field
-
zoom
public int zoom()Required - Zoom level for the vector tile to searchAPI name:
zoom
-
x
public int x()Required - X coordinate for the vector tile to searchAPI name:
x
-
y
public int y()Required - Y coordinate for the vector tile to searchAPI name:
y
-
aggs
Sub-aggregations for the geotile_grid.Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum
API name:
aggs
-
exactBounds
@Nullable public java.lang.Boolean exactBounds()If false, the meta layer’s feature is the bounding box of the tile. If true, the meta layer’s feature is a bounding box resulting from a geo_bounds aggregation. The aggregation runs on <field> values that intersect the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting bounding box may be larger than the vector tile.API name:
exact_bounds
-
extent
@Nullable public java.lang.Integer extent()Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.API name:
extent
-
fields
@Nullable public java.util.List<java.lang.String> fields()Fields to return in thehits
layer. Supports wildcards (*
). This parameter does not support fields with array values. Fields with array values may return inconsistent results.API name:
fields
-
gridPrecision
@Nullable public java.lang.Integer gridPrecision()Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results don’t include the aggs layer.API name:
grid_precision
-
gridType
Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon of the cells bounding box. If 'point' each feature is a Point that is the centroid of the cell.API name:
grid_type
-
query
Query DSL used to filter documents for the search.API name:
query
-
runtimeMappings
Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.API name:
runtime_mappings
-
size
@Nullable public java.lang.Integer size()Maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don’t include the hits layer.API name:
size
-
sort
@Nullable public java.util.List<jakarta.json.JsonValue> sort()Sorts features in the hits layer. By default, the API calculates a bounding box for each feature. It sorts features based on this box’s diagonal length, from longest to shortest.API name:
sort
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSearchMvtRequestDeserializer
protected static void setupSearchMvtRequestDeserializer(DelegatingDeserializer<SearchMvtRequest.Builder> op)
-