Search a vector tile.
- Search a vector tile for geospatial values.
-
-
- ``_
+ Search a vector tile for geospatial values.
+ Before using this API, you should be familiar with the Mapbox vector tile specification.
+ The API returns results as a binary mapbox vector tile.
+ Internally, Elasticsearch translates a vector tile search API request into a search containing:
+
+ - A
geo_bounding_box query on the <field>. The query uses the <zoom>/<x>/<y> tile as a bounding box.
+ - A
geotile_grid or geohex_grid aggregation on the <field>. The grid_agg parameter determines the aggregation type. The aggregation uses the <zoom>/<x>/<y> tile as a bounding box.
+ - Optionally, a
geo_bounds aggregation on the <field>. The search only includes this aggregation if the exact_bounds parameter is true.
+ - If the optional parameter
with_labels is true, the internal search will include a dynamic runtime field that calls the getLabelPosition function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.
+
+ For example, Elasticsearch may translate a vector tile search API request with a grid_agg argument of geotile and an exact_bounds argument of true into the following search
+ GET my-index/_search
+ {
+ "size": 10000,
+ "query": {
+ "geo_bounding_box": {
+ "my-geo-field": {
+ "top_left": {
+ "lat": -40.979898069620134,
+ "lon": -45
+ },
+ "bottom_right": {
+ "lat": -66.51326044311186,
+ "lon": 0
+ }
+ }
+ }
+ },
+ "aggregations": {
+ "grid": {
+ "geotile_grid": {
+ "field": "my-geo-field",
+ "precision": 11,
+ "size": 65536,
+ "bounds": {
+ "top_left": {
+ "lat": -40.979898069620134,
+ "lon": -45
+ },
+ "bottom_right": {
+ "lat": -66.51326044311186,
+ "lon": 0
+ }
+ }
+ }
+ },
+ "bounds": {
+ "geo_bounds": {
+ "field": "my-geo-field",
+ "wrap_longitude": false
+ }
+ }
+ }
+ }
+
+ The API returns results as a binary Mapbox vector tile.
+ Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:
+
+ - A
hits layer containing a feature for each <field> value matching the geo_bounding_box query.
+ - An
aggs layer containing a feature for each cell of the geotile_grid or geohex_grid. The layer only contains features for cells with matching data.
+ - A meta layer containing:
+
+ - A feature containing a bounding box. By default, this is the bounding box of the tile.
+ - Value ranges for any sub-aggregations on the
geotile_grid or geohex_grid.
+ - Metadata for the search.
+
+
+
+ The API only returns features that can display at its zoom level.
+ For example, if a polygon feature has no area at its zoom level, the API omits it.
+ The API returns errors as UTF-8 encoded JSON.
+ IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.
+ If you specify both parameters, the query parameter takes precedence.
+ Grid precision for geotile
+ For a grid_agg of geotile, you can use cells in the aggs layer as tiles for lower zoom levels.
+ grid_precision represents the additional zoom levels available through these cells. The final precision is computed by as follows: <zoom> + grid_precision.
+ For example, if <zoom> is 7 and grid_precision is 8, then the geotile_grid aggregation will use a precision of 15.
+ The maximum final precision is 29.
+ The grid_precision also determines the number of cells for the grid as follows: (2^grid_precision) x (2^grid_precision).
+ For example, a value of 8 divides the tile into a grid of 256 x 256 cells.
+ The aggs layer only contains features for cells with matching data.
+ Grid precision for geohex
+ For a grid_agg of geohex, Elasticsearch uses <zoom> and grid_precision to calculate a final precision as follows: <zoom> + grid_precision.
+ This precision determines the H3 resolution of the hexagonal cells produced by the geohex aggregation.
+ The following table maps the H3 resolution for each precision.
+ For example, if <zoom> is 3 and grid_precision is 3, the precision is 6.
+ At a precision of 6, hexagonal cells have an H3 resolution of 2.
+ If <zoom> is 3 and grid_precision is 4, the precision is 7.
+ At a precision of 7, hexagonal cells have an H3 resolution of 3.
+
+
+
+ | Precision |
+ Unique tile bins |
+ H3 resolution |
+ Unique hex bins |
+ Ratio |
+
+
+
+
+ | 1 |
+ 4 |
+ 0 |
+ 122 |
+ 30.5 |
+
+
+ | 2 |
+ 16 |
+ 0 |
+ 122 |
+ 7.625 |
+
+
+ | 3 |
+ 64 |
+ 1 |
+ 842 |
+ 13.15625 |
+
+
+ | 4 |
+ 256 |
+ 1 |
+ 842 |
+ 3.2890625 |
+
+
+ | 5 |
+ 1024 |
+ 2 |
+ 5882 |
+ 5.744140625 |
+
+
+ | 6 |
+ 4096 |
+ 2 |
+ 5882 |
+ 1.436035156 |
+
+
+ | 7 |
+ 16384 |
+ 3 |
+ 41162 |
+ 2.512329102 |
+
+
+ | 8 |
+ 65536 |
+ 3 |
+ 41162 |
+ 0.6280822754 |
+
+
+ | 9 |
+ 262144 |
+ 4 |
+ 288122 |
+ 1.099098206 |
+
+
+ | 10 |
+ 1048576 |
+ 4 |
+ 288122 |
+ 0.2747745514 |
+
+
+ | 11 |
+ 4194304 |
+ 5 |
+ 2016842 |
+ 0.4808526039 |
+
+
+ | 12 |
+ 16777216 |
+ 6 |
+ 14117882 |
+ 0.8414913416 |
+
+
+ | 13 |
+ 67108864 |
+ 6 |
+ 14117882 |
+ 0.2103728354 |
+
+
+ | 14 |
+ 268435456 |
+ 7 |
+ 98825162 |
+ 0.3681524172 |
+
+
+ | 15 |
+ 1073741824 |
+ 8 |
+ 691776122 |
+ 0.644266719 |
+
+
+ | 16 |
+ 4294967296 |
+ 8 |
+ 691776122 |
+ 0.1610666797 |
+
+
+ | 17 |
+ 17179869184 |
+ 9 |
+ 4842432842 |
+ 0.2818666889 |
+
+
+ | 18 |
+ 68719476736 |
+ 10 |
+ 33897029882 |
+ 0.4932667053 |
+
+
+ | 19 |
+ 274877906944 |
+ 11 |
+ 237279209162 |
+ 0.8632167343 |
+
+
+ | 20 |
+ 1099511627776 |
+ 11 |
+ 237279209162 |
+ 0.2158041836 |
+
+
+ | 21 |
+ 4398046511104 |
+ 12 |
+ 1660954464122 |
+ 0.3776573213 |
+
+
+ | 22 |
+ 17592186044416 |
+ 13 |
+ 11626681248842 |
+ 0.6609003122 |
+
+
+ | 23 |
+ 70368744177664 |
+ 13 |
+ 11626681248842 |
+ 0.165225078 |
+
+
+ | 24 |
+ 281474976710656 |
+ 14 |
+ 81386768741882 |
+ 0.2891438866 |
+
+
+ | 25 |
+ 1125899906842620 |
+ 15 |
+ 569707381193162 |
+ 0.5060018015 |
+
+
+ | 26 |
+ 4503599627370500 |
+ 15 |
+ 569707381193162 |
+ 0.1265004504 |
+
+
+ | 27 |
+ 18014398509482000 |
+ 15 |
+ 569707381193162 |
+ 0.03162511259 |
+
+
+ | 28 |
+ 72057594037927900 |
+ 15 |
+ 569707381193162 |
+ 0.007906278149 |
+
+
+ | 29 |
+ 288230376151712000 |
+ 15 |
+ 569707381193162 |
+ 0.001976569537 |
+
+
+
+ Hexagonal cells don't align perfectly on a vector tile.
+ Some cells may intersect more than one vector tile.
+ To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.
+ Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
+
+
+ ``_
:param index: Comma-separated list of data streams, indices, or aliases to search
:param field: Field containing geospatial data to return
:param zoom: Zoom level for the vector tile to search
:param x: X coordinate for the vector tile to search
:param y: Y coordinate for the vector tile to search
- :param aggs: Sub-aggregations for the geotile_grid. Supports the following aggregation
- types: - avg - cardinality - max - min - sum
- :param 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.
- :param exact_bounds: 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 values that intersect
- the // tile with wrap_longitude set to false. The resulting bounding
- box may be larger than the vector tile.
- :param extent: Size, in pixels, of a side of the tile. Vector tiles are square
+ :param aggs: Sub-aggregations for the geotile_grid. It supports the following
+ aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats`
+ - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank`
+ - `stats` - `sum` - `value count` The aggregation names can't start with
+ `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.
+ :param buffer: The 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.
+ :param exact_bounds: 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 values that
+ intersect the `//` tile with `wrap_longitude` set to `false`.
+ The resulting bounding box may be larger than the vector tile.
+ :param extent: The size, in pixels, of a side of the tile. Vector tiles are square
with equal sides.
- :param fields: Fields to return in the `hits` layer. Supports wildcards (`*`).
- This parameter does not support fields with array values. Fields with array
- values may return inconsistent results.
- :param grid_agg: Aggregation used to create a grid for the `field`.
+ :param fields: The fields to return in the `hits` layer. It supports wildcards
+ (`*`). This parameter does not support fields with array values. Fields with
+ array values may return inconsistent results.
+ :param grid_agg: The aggregation used to create a grid for the `field`.
:param grid_precision: Additional zoom levels available through the aggs layer.
- For example, if 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.
+ For example, if `` 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.
:param grid_type: 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
+ 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.
- :param query: Query DSL used to filter documents for the search.
+ :param query: The query DSL used to filter documents for the search.
:param runtime_mappings: Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name.
- :param size: Maximum number of features to return in the hits layer. Accepts
- 0-10000. If 0, results don’t include the hits layer.
- :param 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
+ :param size: The maximum number of features to return in the hits layer. Accepts
+ 0-10000. If 0, results don't include the hits layer.
+ :param sort: Sort the 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.
- :param track_total_hits: Number of hits matching the query to count accurately.
+ :param track_total_hits: The number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching
the query.
:param with_labels: If `true`, the hits and aggs layers will contain additional
point features representing suggested label positions for the original features.
+ * `Point` and `MultiPoint` features will have one of the points selected.
+ * `Polygon` and `MultiPolygon` features will have a single point generated,
+ either the centroid, if it is within the polygon, or another point within
+ the polygon selected from the sorted triangle-tree. * `LineString` features
+ will likewise provide a roughly central point selected from the triangle-tree.
+ * The aggregation results will provide one central point for each aggregation
+ bucket. All attributes from the original features will also be copied to
+ the new label features. In addition, the new features will be distinguishable
+ using the tag `_mvt_label_position`.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
@@ -5254,13 +5626,15 @@ async def search_shards(
Get the search shards.
Get the indices and shards that a search request would be run against.
This information can be useful for working out issues or planning optimizations with routing and shard preferences.
- When filtered aliases are used, the filter is returned as part of the indices section.
+ When filtered aliases are used, the filter is returned as part of the indices section.
+ If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the target data stream, index, or alias.
- ``_
+ ``_
- :param index: Returns the indices and shards that a search request would be executed
- against.
+ :param index: A comma-separated list of data streams, indices, and aliases to
+ search. It supports wildcards (`*`). To search all data streams and indices,
+ omit this parameter or use `*` or `_all`.
:param allow_no_indices: If `false`, the request returns an error if any wildcard
expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. For
@@ -5274,10 +5648,13 @@ async def search_shards(
a missing or closed index.
:param local: If `true`, the request retrieves information from the local node
only.
- :param master_timeout: Period to wait for a connection to the master node.
- :param preference: Specifies the node or shard the operation should be performed
- on. Random by default.
- :param routing: Custom value used to route operations to a specific shard.
+ :param master_timeout: The period to wait for a connection to the master node.
+ If the master node is not available before the timeout expires, the request
+ fails and returns an error. IT can also be set to `-1` to indicate that the
+ request should never timeout.
+ :param preference: The node or shard the operation should be performed on. It
+ is random by default.
+ :param routing: A custom value used to route operations to a specific shard.
"""
__path_parts: t.Dict[str, str]
if index not in SKIP_IN_PATH:
@@ -5364,10 +5741,10 @@ async def search_template(
Run a search with a search template.
- ``_
+ ``_
- :param index: Comma-separated list of data streams, indices, and aliases to search.
- Supports wildcards (*).
+ :param index: A comma-separated list of data streams, indices, and aliases to
+ search. It supports wildcards (`*`).
:param allow_no_indices: If `false`, the request returns an error if any wildcard
expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. For
@@ -5375,32 +5752,34 @@ async def search_template(
with `foo` but no index starts with `bar`.
:param ccs_minimize_roundtrips: If `true`, network round-trips are minimized
for cross-cluster search requests.
- :param expand_wildcards: Type of index that wildcard patterns can match. If the
- request can target data streams, this argument determines whether wildcard
- expressions match hidden data streams. Supports comma-separated values, such
- as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+ :param expand_wildcards: The type of index that wildcard patterns can match.
+ If the request can target data streams, this argument determines whether
+ wildcard expressions match hidden data streams. Supports comma-separated
+ values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`,
+ `hidden`, `none`.
:param explain: If `true`, returns detailed information about score calculation
- as part of each hit.
- :param id: ID of the search template to use. If no source is specified, this
- parameter is required.
+ as part of each hit. If you specify both this and the `explain` query parameter,
+ the API uses only the query parameter.
+ :param id: The ID of the search template to use. If no `source` is specified,
+ this parameter is required.
:param ignore_throttled: If `true`, specified concrete, expanded, or aliased
indices are not included in the response when throttled.
:param ignore_unavailable: If `false`, the request returns an error if it targets
a missing or closed index.
:param params: Key-value pairs used to replace Mustache variables in the template.
The key is the variable name. The value is the variable value.
- :param preference: Specifies the node or shard the operation should be performed
- on. Random by default.
+ :param preference: The node or shard the operation should be performed on. It
+ is random by default.
:param profile: If `true`, the query execution is profiled.
- :param rest_total_hits_as_int: If true, hits.total are rendered as an integer
- in the response.
- :param routing: Custom value used to route operations to a specific shard.
+ :param rest_total_hits_as_int: If `true`, `hits.total` is rendered as an integer
+ in the response. If `false`, it is rendered as an object.
+ :param routing: A custom value used to route operations to a specific shard.
:param scroll: Specifies how long a consistent view of the index should be maintained
for scrolled search.
:param search_type: The type of the search operation.
:param source: An inline search template. Supports the same parameters as the
- search API's request body. Also supports Mustache variables. If no id is
- specified, this parameter is required.
+ search API's request body. It also supports Mustache variables. If no `id`
+ is specified, this parameter is required.
:param typed_keys: If `true`, the response prefixes aggregation and suggester
names with their respective types.
"""
@@ -5498,30 +5877,35 @@ async def terms_enum(
Get terms in an index.
Discover terms that match a partial string in an index.
- This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios.
- If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate.
- This can occur due to a few reasons, such as a request timeout or a node error.
- NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.
+ This API is designed for low-latency look-ups used in auto-complete scenarios.
+
+ info
+ The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.
+
- ``_
+ ``_
- :param index: Comma-separated list of data streams, indices, and index aliases
- to search. Wildcard (*) expressions are supported.
+ :param index: A comma-separated list of data streams, indices, and index aliases
+ to search. Wildcard (`*`) expressions are supported. To search all data streams
+ or indices, omit this parameter or use `*` or `_all`.
:param field: The string to match at the start of indexed terms. If not provided,
all terms in the field are considered.
- :param case_insensitive: When true the provided search string is matched against
+ :param case_insensitive: When `true`, the provided search string is matched against
index terms without case sensitivity.
- :param index_filter: Allows to filter an index shard if the provided query rewrites
- to match_none.
- :param search_after:
- :param size: How many matching terms to return.
- :param string: The string after which terms in the index should be returned.
- Allows for a form of pagination if the last result from one request is passed
- as the search_after parameter for a subsequent request.
- :param timeout: The maximum length of time to spend collecting results. Defaults
- to "1s" (one second). If the timeout is exceeded the complete flag set to
- false in the response and the results may be partial or empty.
+ :param index_filter: Filter an index shard if the provided query rewrites to
+ `match_none`.
+ :param search_after: The string after which terms in the index should be returned.
+ It allows for a form of pagination if the last result from one request is
+ passed as the `search_after` parameter for a subsequent request.
+ :param size: The number of matching terms to return.
+ :param string: The string to match at the start of indexed terms. If it is not
+ provided, all terms in the field are considered. > info > The prefix string
+ cannot be larger than the largest possible keyword value, which is Lucene's
+ term byte-length limit of 32766.
+ :param timeout: The maximum length of time to spend collecting results. If the
+ timeout is exceeded the `complete` flag set to `false` in the response and
+ the results may be partial or empty.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
@@ -5604,32 +5988,73 @@ async def termvectors(
Get term vector information.
Get information and statistics about terms in the fields of a particular document.
+ You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.
+ You can specify the fields you are interested in through the fields parameter or by adding the fields to the request body.
+ For example:
+ GET /my-index-000001/_termvectors/1?fields=message
+
+ Fields can be specified using wildcards, similar to the multi match query.
+ Term vectors are real-time by default, not near real-time.
+ This can be changed by setting realtime parameter to false.
+ You can request three types of values: term information, term statistics, and field statistics.
+ By default, all term information and field statistics are returned for all fields but term statistics are excluded.
+ Term information
+
+ - term frequency in the field (always returned)
+ - term positions (
positions: true)
+ - start and end offsets (
offsets: true)
+ - term payloads (
payloads: true), as base64 encoded bytes
+
+ If the requested information wasn't stored in the index, it will be computed on the fly if possible.
+ Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.
+
+ warn
+ Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.
+
+ Behaviour
+ The term and field statistics are not accurate.
+ Deleted documents are not taken into account.
+ The information is only retrieved for the shard the requested document resides in.
+ The term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.
+ By default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.
+ Use routing only to hit a particular shard.
+
+
+ ``_
-
- ``_
-
- :param index: Name of the index that contains the document.
- :param id: Unique identifier of the document.
+ :param index: The name of the index that contains the document.
+ :param id: A unique identifier for the document.
:param doc: An artificial document (a document not present in the index) for
which you want to retrieve term vectors.
- :param field_statistics: If `true`, the response includes the document count,
- sum of document frequencies, and sum of total term frequencies.
- :param fields: Comma-separated list or wildcard expressions of fields to include
- in the statistics. Used as the default list unless a specific field list
- is provided in the `completion_fields` or `fielddata_fields` parameters.
- :param filter: Filter terms based on their tf-idf scores.
+ :param field_statistics: If `true`, the response includes: * The document count
+ (how many documents contain this field). * The sum of document frequencies
+ (the sum of document frequencies for all terms in this field). * The sum
+ of total term frequencies (the sum of total term frequencies of each term
+ in this field).
+ :param fields: A comma-separated list or wildcard expressions of fields to include
+ in the statistics. It is used as the default list unless a specific field
+ list is provided in the `completion_fields` or `fielddata_fields` parameters.
+ :param filter: Filter terms based on their tf-idf scores. This could be useful
+ in order find out a good characteristic vector of a document. This feature
+ works in a similar manner to the second phase of the More Like This Query.
:param offsets: If `true`, the response includes term offsets.
:param payloads: If `true`, the response includes term payloads.
- :param per_field_analyzer: Overrides the default per-field analyzer.
+ :param per_field_analyzer: Override the default per-field analyzer. This is useful
+ in order to generate term vectors in any fashion, especially when using artificial
+ documents. When providing an analyzer for a field that already stores term
+ vectors, the term vectors will be regenerated.
:param positions: If `true`, the response includes term positions.
- :param preference: Specifies the node or shard the operation should be performed
- on. Random by default.
+ :param preference: The node or shard the operation should be performed on. It
+ is random by default.
:param realtime: If true, the request is real-time as opposed to near-real-time.
- :param routing: Custom value used to route operations to a specific shard.
- :param term_statistics: If `true`, the response includes term frequency and document
- frequency.
+ :param routing: A custom value that is used to route operations to a specific
+ shard.
+ :param term_statistics: If `true`, the response includes: * The total term frequency
+ (how often a term occurs in all documents). * The document frequency (the
+ number of documents containing the current term). By default these values
+ are not returned since term statistics can have a serious performance impact.
:param version: If `true`, returns the document version as part of a hit.
- :param version_type: Specific version type.
+ :param version_type: The version type.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
@@ -5765,7 +6190,7 @@ async def update(
In addition to _source, you can access the following variables through the ctx map: _index, _type, _id, _version, _routing, and _now (the current timestamp).
- ``_
+ ``_
:param index: The name of the target index. By default, the index is created
automatically if it doesn't exist.
@@ -5999,7 +6424,7 @@ async def update_by_query(
This API enables you to only modify the source of matching documents; you cannot move them.
- ``_
+ ``_
:param index: A comma-separated list of data streams, indices, and aliases to
search. It supports wildcards (`*`). To search all data streams or indices,
@@ -6219,7 +6644,7 @@ async def update_by_query_rethrottle(
Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
- ``_
+ ``_
:param task_id: The ID for the task.
:param requests_per_second: The throttle for this request in sub-requests per
diff --git a/elasticsearch/_async/client/async_search.py b/elasticsearch/_async/client/async_search.py
index 3679824ab..c40749b22 100644
--- a/elasticsearch/_async/client/async_search.py
+++ b/elasticsearch/_async/client/async_search.py
@@ -44,7 +44,7 @@ async def delete(
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege.
- ``_
+ ``_
:param id: A unique identifier for the async search.
"""
@@ -94,7 +94,7 @@ async def get(
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
- ``_
+ ``_
:param id: A unique identifier for the async search.
:param keep_alive: Specifies how long the async search should be available in
@@ -160,7 +160,7 @@ async def status(
If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role.
- ``_
+ ``_
:param id: A unique identifier for the async search.
:param keep_alive: Specifies how long the async search needs to be available.
@@ -341,7 +341,7 @@ async def submit(
The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.
- ``_
+ ``_
:param index: A comma-separated list of index names to search; use `_all` or
empty string to perform the operation on all indices
diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py
index 68fc804dc..5b41caa38 100644
--- a/elasticsearch/_async/client/autoscaling.py
+++ b/elasticsearch/_async/client/autoscaling.py
@@ -44,7 +44,7 @@ async def delete_autoscaling_policy(
NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
- ``_
+ ``_
:param name: the name of the autoscaling policy
:param master_timeout: Period to wait for a connection to the master node. If
@@ -104,7 +104,7 @@ async def get_autoscaling_capacity(
Do not use this information to make autoscaling decisions.
- ``_
+ ``_
:param master_timeout: Period to wait for a connection to the master node. If
no response is received before the timeout expires, the request fails and
@@ -151,7 +151,7 @@ async def get_autoscaling_policy(
NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
- ``_
+ ``_
:param name: the name of the autoscaling policy
:param master_timeout: Period to wait for a connection to the master node. If
@@ -206,7 +206,7 @@ async def put_autoscaling_policy(
NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
- ``_
+ ``_
:param name: the name of the autoscaling policy
:param policy:
diff --git a/elasticsearch/_async/client/cat.py b/elasticsearch/_async/client/cat.py
index cd9194517..299ee83ac 100644
--- a/elasticsearch/_async/client/cat.py
+++ b/elasticsearch/_async/client/cat.py
@@ -64,7 +64,7 @@ async def aliases(
IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
- ``_
+ ``_
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -154,7 +154,7 @@ async def allocation(
IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
- ``_
+ ``_
:param node_id: A comma-separated list of node identifiers or names used to limit
the returned information.
@@ -243,7 +243,7 @@ async def component_templates(
They are not intended for use by applications. For application consumption, use the get component template API.
- ``_
+ ``_
:param name: The name of the component template. It accepts wildcard expressions.
If it is omitted, all component templates are returned.
@@ -327,7 +327,7 @@ async def count(
They are not intended for use by applications. For application consumption, use the count API.
- ``_
+ ``_
:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. It supports wildcards (`*`). To target all data streams
@@ -405,7 +405,7 @@ async def fielddata(
They are not intended for use by applications. For application consumption, use the nodes stats API.
- ``_
+ ``_
:param fields: Comma-separated list of fields used to limit returned information.
To retrieve all fields, omit this parameter.
@@ -491,7 +491,7 @@ async def health(
You also can use the API to track the recovery of a large cluster over a longer period of time.
- ``_
+ ``_
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -549,7 +549,7 @@ async def help(self) -> TextApiResponse:
Get help for the CAT APIs.
- ``_
+ ``_
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_cat"
@@ -616,7 +616,7 @@ async def indices(
They are not intended for use by applications. For application consumption, use an index endpoint.
- ``_
+ ``_
:param index: Comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -714,7 +714,7 @@ async def master(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
- ``_
+ ``_
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -892,7 +892,7 @@ async def ml_data_frame_analytics(
application consumption, use the get data frame analytics jobs statistics API.
- ``_
+ ``_
:param id: The ID of the data frame analytics to fetch
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1060,7 +1060,7 @@ async def ml_datafeeds(
application consumption, use the get datafeed statistics API.
- ``_
+ ``_
:param datafeed_id: A numerical character string that uniquely identifies the
datafeed.
@@ -1426,7 +1426,7 @@ async def ml_jobs(
application consumption, use the get anomaly detection job statistics API.
- ``_
+ ``_
:param job_id: Identifier for the anomaly detection job.
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1611,7 +1611,7 @@ async def ml_trained_models(
application consumption, use the get trained models statistics API.
- ``_
+ ``_
:param model_id: A unique identifier for the trained model.
:param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1704,7 +1704,7 @@ async def nodeattrs(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
- ``_
+ ``_
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1787,7 +1787,7 @@ async def nodes(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
- ``_
+ ``_
:param bytes: The unit used to display byte values.
:param format: Specifies the format to return the columnar data in, can be set
@@ -1874,7 +1874,7 @@ async def pending_tasks(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
- ``_
+ ``_
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1954,7 +1954,7 @@ async def plugins(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
- ``_
+ ``_
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2042,7 +2042,7 @@ async def recovery(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
- ``_
+ ``_
:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2130,7 +2130,7 @@ async def repositories(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
- ``_
+ ``_
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2211,7 +2211,7 @@ async def segments(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
- ``_
+ ``_
:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2305,7 +2305,7 @@ async def shards(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
- ``_
+ ``_
:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2394,7 +2394,7 @@ async def snapshots(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
- ``_
+ ``_
:param repository: A comma-separated list of snapshot repositories used to limit
the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2487,7 +2487,7 @@ async def tasks(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
- ``_
+ ``_
:param actions: The task action names, which are used to limit the response.
:param detailed: If `true`, the response includes detailed information about
@@ -2581,7 +2581,7 @@ async def templates(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
- ``_
+ ``_
:param name: The name of the template to return. Accepts wildcard expressions.
If omitted, all templates are returned.
@@ -2669,7 +2669,7 @@ async def thread_pool(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
- ``_
+ ``_
:param thread_pool_patterns: A comma-separated list of thread pool names used
to limit the request. Accepts wildcard expressions.
@@ -2926,7 +2926,7 @@ async def transforms(
application consumption, use the get transform statistics API.
- ``_
+ ``_
:param transform_id: A transform identifier or a wildcard expression. If you
do not specify one of these options, the API returns information for all
diff --git a/elasticsearch/_async/client/ccr.py b/elasticsearch/_async/client/ccr.py
index b54f1cdad..c834de777 100644
--- a/elasticsearch/_async/client/ccr.py
+++ b/elasticsearch/_async/client/ccr.py
@@ -43,7 +43,7 @@ async def delete_auto_follow_pattern(
Delete a collection of cross-cluster replication auto-follow patterns.
- ``_
+ ``_
:param name: The name of the auto follow pattern.
:param master_timeout: Period to wait for a connection to the master node.
@@ -127,7 +127,7 @@ async def follow(
When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.
- ``_
+ ``_
:param index: The name of the follower index.
:param leader_index: The name of the index in the leader cluster to follow.
@@ -256,7 +256,7 @@ async def follow_info(
For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.
- ``_
+ ``_
:param index: A comma-separated list of index patterns; use `_all` to perform
the operation on all indices
@@ -301,17 +301,16 @@ async def follow_stats(
"""
.. raw:: html
- Get follower stats.
- Get cross-cluster replication follower stats.
+
Get follower stats.
+ Get cross-cluster replication follower stats.
The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.
- ``_
+ ``_
- :param index: A comma-separated list of index patterns; use `_all` to perform
- the operation on all indices
- :param timeout: Period to wait for a response. If no response is received before
- the timeout expires, the request fails and returns an error.
+ :param index: A comma-delimited list of index patterns.
+ :param timeout: The period to wait for a response. If no response is received
+ before the timeout expires, the request fails and returns an error.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
@@ -376,7 +375,7 @@ async def forget_follower(
The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.
- ``_
+ ``_
:param index: the name of the leader index for which specified follower retention
leases should be removed
@@ -437,15 +436,18 @@ async def get_auto_follow_pattern(
"""
.. raw:: html
- Get auto-follow patterns.
- Get cross-cluster replication auto-follow patterns.
+ Get auto-follow patterns.
+ Get cross-cluster replication auto-follow patterns.
- ``_
+ ``_
- :param name: Specifies the auto-follow pattern collection that you want to retrieve.
- If you do not specify a name, the API returns information for all collections.
- :param master_timeout: Period to wait for a connection to the master node.
+ :param name: The auto-follow pattern collection that you want to retrieve. If
+ you do not specify a name, the API returns information for all collections.
+ :param master_timeout: The period to wait for a connection to the master node.
+ If the master node is not available before the timeout expires, the request
+ fails and returns an error. It can also be set to `-1` to indicate that the
+ request should never timeout.
"""
__path_parts: t.Dict[str, str]
if name not in SKIP_IN_PATH:
@@ -489,8 +491,8 @@ async def pause_auto_follow_pattern(
"""
.. raw:: html
- Pause an auto-follow pattern.
- Pause a cross-cluster replication auto-follow pattern.
+
Pause an auto-follow pattern.
+ Pause a cross-cluster replication auto-follow pattern.
When the API returns, the auto-follow pattern is inactive.
New indices that are created on the remote cluster and match the auto-follow patterns are ignored.
You can resume auto-following with the resume auto-follow pattern API.
@@ -498,11 +500,13 @@ async def pause_auto_follow_pattern(
Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.
- ``_
+ ``_
- :param name: The name of the auto follow pattern that should pause discovering
- new indices to follow.
- :param master_timeout: Period to wait for a connection to the master node.
+ :param name: The name of the auto-follow pattern to pause.
+ :param master_timeout: The period to wait for a connection to the master node.
+ If the master node is not available before the timeout expires, the request
+ fails and returns an error. It can also be set to `-1` to indicate that the
+ request should never timeout.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'name'")
@@ -543,18 +547,20 @@ async def pause_follow(
"""
.. raw:: html
- Pause a follower.
- Pause a cross-cluster replication follower index.
+
Pause a follower.
+ Pause a cross-cluster replication follower index.
The follower index will not fetch any additional operations from the leader index.
You can resume following with the resume follower API.
You can pause and resume a follower index to change the configuration of the following task.
- ``_
+ ``_
- :param index: The name of the follower index that should pause following its
- leader index.
- :param master_timeout: Period to wait for a connection to the master node.
+ :param index: The name of the follower index.
+ :param master_timeout: The period to wait for a connection to the master node.
+ If the master node is not available before the timeout expires, the request
+ fails and returns an error. It can also be set to `-1` to indicate that the
+ request should never timeout.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
@@ -637,7 +643,7 @@ async def put_auto_follow_pattern(
NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.
- ``_
+ ``_
:param name: The name of the collection of auto-follow patterns.
:param remote_cluster: The remote cluster containing the leader indices to match
@@ -765,17 +771,19 @@ async def resume_auto_follow_pattern(
"""
.. raw:: html
- Resume an auto-follow pattern.
- Resume a cross-cluster replication auto-follow pattern that was paused.
+
Resume an auto-follow pattern.
+ Resume a cross-cluster replication auto-follow pattern that was paused.
The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.
Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.
- ``_
+ ``_
- :param name: The name of the auto follow pattern to resume discovering new indices
- to follow.
- :param master_timeout: Period to wait for a connection to the master node.
+ :param name: The name of the auto-follow pattern to resume.
+ :param master_timeout: The period to wait for a connection to the master node.
+ If the master node is not available before the timeout expires, the request
+ fails and returns an error. It can also be set to `-1` to indicate that the
+ request should never timeout.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'name'")
@@ -847,7 +855,7 @@ async def resume_follow(
When this API returns, the follower index will resume fetching operations from the leader index.
- ``_
+ ``_
:param index: The name of the follow index to resume following.
:param master_timeout: Period to wait for a connection to the master node.
@@ -934,15 +942,18 @@ async def stats(
"""
.. raw:: html
- Get cross-cluster replication stats.
- This API returns stats about auto-following and the same shard-level stats as the get follower stats API.
+ Get cross-cluster replication stats.
+ This API returns stats about auto-following and the same shard-level stats as the get follower stats API.
- ``_
+ ``_
- :param master_timeout: Period to wait for a connection to the master node.
- :param timeout: Period to wait for a response. If no response is received before
- the timeout expires, the request fails and returns an error.
+ :param master_timeout: The period to wait for a connection to the master node.
+ If the master node is not available before the timeout expires, the request
+ fails and returns an error. It can also be set to `-1` to indicate that the
+ request should never timeout.
+ :param timeout: The period to wait for a response. If no response is received
+ before the timeout expires, the request fails and returns an error.
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_ccr/stats"
@@ -983,18 +994,23 @@ async def unfollow(
"""
.. raw:: html
- Unfollow an index.
- Convert a cross-cluster replication follower index to a regular index.
+
Unfollow an index.
+ Convert a cross-cluster replication follower index to a regular index.
The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
The follower index must be paused and closed before you call the unfollow API.
- NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.
+
+ info
+ Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.
+
- ``_
+ ``_
- :param index: The name of the follower index that should be turned into a regular
- index.
- :param master_timeout: Period to wait for a connection to the master node.
+ :param index: The name of the follower index.
+ :param master_timeout: The period to wait for a connection to the master node.
+ If the master node is not available before the timeout expires, the request
+ fails and returns an error. It can also be set to `-1` to indicate that the
+ request should never timeout.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
diff --git a/elasticsearch/_async/client/cluster.py b/elasticsearch/_async/client/cluster.py
index 4e2a53fe5..074bdc0e8 100644
--- a/elasticsearch/_async/client/cluster.py
+++ b/elasticsearch/_async/client/cluster.py
@@ -54,7 +54,7 @@ async def allocation_explain(
This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.
- ``_
+ ``_
:param current_node: Specifies the node ID or the name of the node to only explain
a shard that is currently located on the specified node.
@@ -130,7 +130,7 @@ async def delete_component_template(
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
- ``_
+ ``_
:param name: Comma-separated list or wildcard expression of component template
names used to limit the request.
@@ -185,7 +185,7 @@ async def delete_voting_config_exclusions(
Remove master-eligible nodes from the voting configuration exclusion list.
- ``_
+ ``_
:param master_timeout: Period to wait for a connection to the master node.
:param wait_for_removal: Specifies whether to wait for all excluded nodes to
@@ -239,7 +239,7 @@ async def exists_component_template(
Returns information about whether a particular component template exists.
- ``_
+ ``_
:param name: Comma-separated list of component template names used to limit the
request. Wildcard (*) expressions are supported.
@@ -298,7 +298,7 @@ async def get_component_template(
Get information about component templates.
- ``_
+ ``_
:param name: Comma-separated list of component template names used to limit the
request. Wildcard (`*`) expressions are supported.
@@ -365,7 +365,7 @@ async def get_settings(
By default, it returns only settings that have been explicitly defined.
- ``_
+ ``_
:param flat_settings: If `true`, returns settings in flat format.
:param include_defaults: If `true`, returns default cluster settings from the
@@ -447,8 +447,8 @@ async def health(
"""
.. raw:: html
- Get the cluster health status.
- You can also use the API to get the health status of only specified data streams and indices.
+
Get the cluster health status.
+ You can also use the API to get the health status of only specified data streams and indices.
For data streams, the API retrieves the health status of the stream’s backing indices.
The cluster health status is: green, yellow or red.
On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.
@@ -457,7 +457,7 @@ async def health(
The cluster status is controlled by the worst index status.
- ``_
+ ``_
:param index: Comma-separated list of data streams, indices, and index aliases
used to limit the request. Wildcard expressions (`*`) are supported. To target
@@ -565,7 +565,7 @@ async def info(
Returns basic information about the cluster.
- ``_
+ ``_
:param target: Limits the information returned to the specific target. Supports
a comma-separated list, such as http,ingest.
@@ -614,7 +614,7 @@ async def pending_tasks(
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.
- ``_
+ ``_
:param local: If `true`, the request retrieves information from the local node
only. If `false`, information is retrieved from the master node.
@@ -680,7 +680,7 @@ async def post_voting_config_exclusions(
They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.
- ``_
+ ``_
:param master_timeout: Period to wait for a connection to the master node.
:param node_ids: A comma-separated list of the persistent ids of the nodes to
@@ -761,7 +761,7 @@ async def put_component_template(
To be applied, a component template must be included in an index template's composed_of list.
- ``_
+ ``_
:param name: Name of the component template to create. Elasticsearch includes
the following built-in component templates: `logs-mappings`; `logs-settings`;
@@ -850,8 +850,8 @@ async def put_settings(
"""
.. raw:: html
- Update the cluster settings.
- Configure and update dynamic settings on a running cluster.
+
Update the cluster settings.
+ Configure and update dynamic settings on a running cluster.
You can also configure dynamic settings locally on an unstarted or shut down node in elasticsearch.yml.
Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.
You can also reset transient or persistent settings by assigning them a null value.
@@ -866,7 +866,7 @@ async def put_settings(
If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.
- ``_
+ ``_
:param flat_settings: Return settings in flat format (default: false)
:param master_timeout: Explicit operation timeout for connection to master node
@@ -920,12 +920,19 @@ async def remote_info(
"""
.. raw:: html
- Get remote cluster information.
- Get all of the configured remote cluster information.
- This API returns connection and endpoint information keyed by the configured remote cluster alias.
+ Get remote cluster information.
+ Get information about configured remote clusters.
+ The API returns connection and endpoint information keyed by the configured remote cluster alias.
+
+ info
+ This API returns information that reflects current state on the local cluster.
+ The connected field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.
+ Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.
+ To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the resolve cluster endpoint.
+
- ``_
+ ``_
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_remote/info"
@@ -982,7 +989,7 @@ async def reroute(
Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the ?retry_failed URI query parameter, which will attempt a single retry round for these shards.
- ``_
+ ``_
:param commands: Defines the commands to perform.
:param dry_run: If true, then the request simulates the operation. It will calculate
@@ -1087,7 +1094,7 @@ async def state(
Instead, obtain the information you require using other more stable cluster APIs.
- ``_
+ ``_
:param metric: Limit the information returned to the specified metrics
:param index: A comma-separated list of index names; use `_all` or empty string
@@ -1175,7 +1182,7 @@ async def stats(
Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
- ``_
+ ``_
:param node_id: Comma-separated list of node filters used to limit returned information.
Defaults to all nodes in the cluster.
diff --git a/elasticsearch/_async/client/connector.py b/elasticsearch/_async/client/connector.py
index 59c85a6a7..debf9e3ce 100644
--- a/elasticsearch/_async/client/connector.py
+++ b/elasticsearch/_async/client/connector.py
@@ -49,7 +49,7 @@ async def check_in(
Update the last_seen field in the connector and set it to the current timestamp.
- ``_
+ ``_
:param connector_id: The unique identifier of the connector to be checked in
"""
@@ -99,7 +99,7 @@ async def delete(
These need to be removed manually.
- ``_
+ ``_
:param connector_id: The unique identifier of the connector to be deleted
:param delete_sync_jobs: A flag indicating if associated sync jobs should be
@@ -152,7 +152,7 @@ async def get(
Get the details about a connector.
- ``_
+ ``_
:param connector_id: The unique identifier of the connector
:param include_deleted: A flag to indicate if the desired connector should be
@@ -256,7 +256,7 @@ async def last_sync(
This action is used for analytics and monitoring.
- ``_
+ ``_
:param connector_id: The unique identifier of the connector to be updated
:param last_access_control_sync_error:
@@ -356,7 +356,7 @@ async def list(
Get information about all connectors.
- ``_
+ ``_
:param connector_name: A comma-separated list of connector names to fetch connector
documents for
@@ -441,7 +441,7 @@ async def post(
Self-managed connectors (Connector clients) are self-managed on your infrastructure.
- ``_
+ ``_
:param description:
:param index_name:
@@ -523,7 +523,7 @@ async def put(
Create or update a connector.
- ``_
+ ``_
:param connector_id: The unique identifier of the connector to be created or
updated. ID is auto-generated if not provided.
@@ -598,7 +598,7 @@ async def sync_job_cancel(
The connector service is then responsible for setting the status of connector sync jobs to cancelled.
- ``_
+ ``_
:param connector_sync_job_id: The unique identifier of the connector sync job
"""
@@ -649,7 +649,7 @@ async def sync_job_check_in(
This service runs automatically on Elastic Cloud for Elastic managed connectors.
- ``_
+ ``_
:param connector_sync_job_id: The unique identifier of the connector sync job
to be checked in.
@@ -709,7 +709,7 @@ async def sync_job_claim(
This service runs automatically on Elastic Cloud for Elastic managed connectors.
- ``_
+ ``_
:param connector_sync_job_id: The unique identifier of the connector sync job.
:param worker_hostname: The host name of the current system that will run the
@@ -771,7 +771,7 @@ async def sync_job_delete(
This is a destructive action that is not recoverable.
- ``_
+ ``_
:param connector_sync_job_id: The unique identifier of the connector sync job
to be deleted
@@ -825,7 +825,7 @@ async def sync_job_error(
This service runs automatically on Elastic Cloud for Elastic managed connectors.
- ``_
+ ``_
:param connector_sync_job_id: The unique identifier for the connector sync job.
:param error: The error for the connector sync job error field.
@@ -879,7 +879,7 @@ async def sync_job_get(
Get a connector sync job.
- ``_
+ ``_
:param connector_sync_job_id: The unique identifier of the connector sync job
"""
@@ -952,7 +952,7 @@ async def sync_job_list(
Get information about all stored connector sync jobs listed by their creation date in ascending order.
- ``_
+ ``_
:param connector_id: A connector id to fetch connector sync jobs for
:param from_: Starting offset (default: 0)
@@ -1018,7 +1018,7 @@ async def sync_job_post(
Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
- ``_
+ ``_
:param id: The id of the associated connector
:param job_type:
@@ -1094,7 +1094,7 @@ async def sync_job_update_stats(
This service runs automatically on Elastic Cloud for Elastic managed connectors.
- ``_
+ ``_
:param connector_sync_job_id: The unique identifier of the connector sync job.
:param deleted_document_count: The number of documents the sync job deleted.
@@ -1177,7 +1177,7 @@ async def update_active_filtering(
Activates the valid draft filtering for a connector.
- ``_
+ `