Class SearchMvtRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.SearchMvtRequest
- All Implemented Interfaces:
JsonpSerializable
Searches a vector tile for geospatial values. Returns results as a binary
Mapbox vector tile.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<SearchMvtRequest>
Json deserializer forSearchMvtRequest
static final Endpoint<SearchMvtRequest,
BinaryResponse, ErrorResponse> Endpoint "search_mvt
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Map<String,
Aggregation> aggs()
Sub-aggregations for the geotile_grid.final Integer
buffer()
Size, in pixels, of a clipping buffer outside the tile.final Boolean
If false, the meta layer’s feature is the bounding box of the tile.final Integer
extent()
Size, in pixels, of a side of the tile.final String
field()
Required - Field containing geospatial data to returnfields()
Fields to return in thehits
layer.final GridAggregationType
gridAgg()
Aggregation used to create a grid for thefield
.final Integer
Additional zoom levels available through the aggs layer.final GridType
gridType()
Determines the geometry type for features in the aggs layer.index()
Required - Comma-separated list of data streams, indices, or aliases to searchstatic SearchMvtRequest
final Query
query()
Query DSL used to filter documents for the search.final Map<String,
RuntimeField> 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
final Integer
size()
Maximum number of features to return in the hits layer.final List<SortOptions>
sort()
Sorts features in the hits layer.final TrackHits
Number of hits matching the query to count accurately.final Boolean
Iftrue
, the hits and aggs layers will contain additional point features representing suggested label positions for the original features.final int
x()
Required - X coordinate for the vector tile to searchfinal int
y()
Required - Y coordinate for the vector tile to searchfinal int
zoom()
Required - Zoom level for the vector tile to searchMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forSearchMvtRequest
-
_ENDPOINT
Endpoint "search_mvt
".
-
-
Method Details
-
of
public static SearchMvtRequest of(Function<SearchMvtRequest.Builder, ObjectBuilder<SearchMvtRequest>> fn) -
aggs
Sub-aggregations for the geotile_grid.Supports the following aggregation types:
- avg
- cardinality
- max
- min
- sum
API name:
aggs
-
buffer
Size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile.API name:
buffer
-
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
Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.API name:
extent
-
field
Required - Field containing geospatial data to returnAPI name:
field
-
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
-
gridAgg
Aggregation used to create a grid for thefield
.API name:
grid_agg
-
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
-
index
Required - Comma-separated list of data streams, indices, or aliases to searchAPI name:
index
-
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
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
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
-
trackTotalHits
Number of hits matching the query to count accurately. Iftrue
, the exact number of hits is returned at the cost of some performance. Iffalse
, the response does not include the total number of hits matching the query.API name:
track_total_hits
-
withLabels
Iftrue
, the hits and aggs layers will contain additional point features representing suggested label positions for the original features.API name:
with_labels
-
x
public final int x()Required - X coordinate for the vector tile to searchAPI name:
x
-
y
public final int y()Required - Y coordinate for the vector tile to searchAPI name:
y
-
zoom
public final int zoom()Required - Zoom level for the vector tile to searchAPI name:
zoom
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSearchMvtRequestDeserializer
protected static void setupSearchMvtRequestDeserializer(ObjectDeserializer<SearchMvtRequest.Builder> op)
-