From eee698b0388b2bf4551f641a050216b34d654d4f Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Mon, 9 Dec 2024 17:43:24 +0400 Subject: [PATCH] Auto-generated code for 8.17 --- elasticsearch/_async/client/__init__.py | 95 ++++++------ elasticsearch/_async/client/async_search.py | 34 ++-- elasticsearch/_async/client/autoscaling.py | 43 +++++- elasticsearch/_async/client/cat.py | 52 +++---- elasticsearch/_async/client/ccr.py | 26 ++-- elasticsearch/_async/client/cluster.py | 32 ++-- elasticsearch/_async/client/connector.py | 50 +++--- .../_async/client/dangling_indices.py | 6 +- elasticsearch/_async/client/enrich.py | 12 +- elasticsearch/_async/client/eql.py | 24 +-- elasticsearch/_async/client/esql.py | 5 +- elasticsearch/_async/client/features.py | 4 +- elasticsearch/_async/client/fleet.py | 2 +- elasticsearch/_async/client/graph.py | 12 +- elasticsearch/_async/client/ilm.py | 22 +-- elasticsearch/_async/client/indices.py | 124 +++++++-------- elasticsearch/_async/client/inference.py | 20 +-- elasticsearch/_async/client/ingest.py | 51 +++--- elasticsearch/_async/client/license.py | 14 +- elasticsearch/_async/client/logstash.py | 6 +- elasticsearch/_async/client/migration.py | 6 +- elasticsearch/_async/client/ml.py | 146 +++++++++--------- elasticsearch/_async/client/monitoring.py | 2 +- elasticsearch/_async/client/nodes.py | 14 +- elasticsearch/_async/client/query_rules.py | 33 ++-- elasticsearch/_async/client/rollup.py | 16 +- .../_async/client/search_application.py | 16 +- .../_async/client/searchable_snapshots.py | 8 +- elasticsearch/_async/client/security.py | 121 ++++++++------- elasticsearch/_async/client/slm.py | 18 +-- elasticsearch/_async/client/snapshot.py | 24 +-- elasticsearch/_async/client/sql.py | 31 ++-- elasticsearch/_async/client/ssl.py | 2 +- elasticsearch/_async/client/synonyms.py | 31 ++-- elasticsearch/_async/client/tasks.py | 6 +- elasticsearch/_async/client/text_structure.py | 4 +- elasticsearch/_async/client/transform.py | 22 +-- elasticsearch/_async/client/watcher.py | 22 +-- elasticsearch/_async/client/xpack.py | 4 +- elasticsearch/_sync/client/__init__.py | 95 ++++++------ elasticsearch/_sync/client/async_search.py | 34 ++-- elasticsearch/_sync/client/autoscaling.py | 43 +++++- elasticsearch/_sync/client/cat.py | 52 +++---- elasticsearch/_sync/client/ccr.py | 26 ++-- elasticsearch/_sync/client/cluster.py | 32 ++-- elasticsearch/_sync/client/connector.py | 50 +++--- .../_sync/client/dangling_indices.py | 6 +- elasticsearch/_sync/client/enrich.py | 12 +- elasticsearch/_sync/client/eql.py | 24 +-- elasticsearch/_sync/client/esql.py | 5 +- elasticsearch/_sync/client/features.py | 4 +- elasticsearch/_sync/client/fleet.py | 2 +- elasticsearch/_sync/client/graph.py | 12 +- elasticsearch/_sync/client/ilm.py | 22 +-- elasticsearch/_sync/client/indices.py | 124 +++++++-------- elasticsearch/_sync/client/inference.py | 20 +-- elasticsearch/_sync/client/ingest.py | 51 +++--- elasticsearch/_sync/client/license.py | 14 +- elasticsearch/_sync/client/logstash.py | 6 +- elasticsearch/_sync/client/migration.py | 6 +- elasticsearch/_sync/client/ml.py | 146 +++++++++--------- elasticsearch/_sync/client/monitoring.py | 2 +- elasticsearch/_sync/client/nodes.py | 14 +- elasticsearch/_sync/client/query_rules.py | 33 ++-- elasticsearch/_sync/client/rollup.py | 16 +- .../_sync/client/search_application.py | 16 +- .../_sync/client/searchable_snapshots.py | 8 +- elasticsearch/_sync/client/security.py | 121 ++++++++------- elasticsearch/_sync/client/slm.py | 18 +-- elasticsearch/_sync/client/snapshot.py | 24 +-- elasticsearch/_sync/client/sql.py | 31 ++-- elasticsearch/_sync/client/ssl.py | 2 +- elasticsearch/_sync/client/synonyms.py | 31 ++-- elasticsearch/_sync/client/tasks.py | 6 +- elasticsearch/_sync/client/text_structure.py | 4 +- elasticsearch/_sync/client/transform.py | 22 +-- elasticsearch/_sync/client/watcher.py | 22 +-- elasticsearch/_sync/client/xpack.py | 4 +- 78 files changed, 1208 insertions(+), 1112 deletions(-) diff --git a/elasticsearch/_async/client/__init__.py b/elasticsearch/_async/client/__init__.py index d5985ca05..d4ca7cce0 100644 --- a/elasticsearch/_async/client/__init__.py +++ b/elasticsearch/_async/client/__init__.py @@ -646,7 +646,7 @@ async def bulk( in a single API call. This reduces overhead and can greatly increase indexing speed. - ``_ + ``_ :param operations: :param index: Name of the data stream, index, or index alias to perform bulk @@ -746,7 +746,7 @@ async def clear_scroll( Clear a scrolling search. Clear the search context and results for a scrolling search. - ``_ + ``_ :param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`. """ @@ -800,7 +800,7 @@ async def close_point_in_time( period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. - ``_ + ``_ :param id: The ID of the point-in-time. """ @@ -872,9 +872,9 @@ async def count( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns number of documents matching a query. + Count search results. Get the number of documents matching a query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -1009,7 +1009,7 @@ async def create( and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template @@ -1113,7 +1113,7 @@ async def delete( """ Delete a document. Removes a JSON document from the specified index. - ``_ + ``_ :param index: Name of the target index. :param id: Unique identifier for the document. @@ -1235,7 +1235,7 @@ async def delete_by_query( """ Delete documents. Deletes documents that match the specified query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -1416,7 +1416,7 @@ async def delete_by_query_rethrottle( 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 @@ -1462,7 +1462,7 @@ async def delete_script( """ Delete a script or search template. Deletes a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Period to wait for a connection to the master node. If @@ -1530,7 +1530,7 @@ async def exists( """ Check a document. Checks if a specified document exists. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1631,7 +1631,7 @@ async def exists_source( """ Check for a document source. Checks if a document's `_source` is stored. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1732,7 +1732,7 @@ async def explain( Explain a document match result. Returns information about why a specific document matches, or doesn’t match, a query. - ``_ + ``_ :param index: Index names used to limit the request. Only a single index name can be provided to this parameter. @@ -1855,7 +1855,7 @@ async def field_caps( field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -1972,7 +1972,7 @@ async def get( Get a document by its ID. Retrieves the document with the specified ID from an index. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2061,7 +2061,7 @@ async def get_script( """ Get a script or search template. Retrieves a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Specify timeout for connection to master @@ -2103,7 +2103,7 @@ async def get_script_context( """ Get script contexts. Get a list of supported script contexts and their methods. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_context" @@ -2138,7 +2138,7 @@ async def get_script_languages( """ Get script languages. Get a list of available script types, languages, and contexts. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_language" @@ -2193,7 +2193,7 @@ async def get_source( """ Get a document's source. Returns the source of a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2276,7 +2276,7 @@ async def health_report( """ Returns the health of the cluster. - ``_ + ``_ :param feature: A feature of the cluster, as returned by the top-level health report API. @@ -2353,7 +2353,7 @@ async def index( and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. :param document: @@ -2462,7 +2462,7 @@ async def info( """ Get cluster info. Returns basic information about the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/" @@ -2527,7 +2527,7 @@ async def knn_search( The kNN search API supports restricting the search using a filter. The search will return the top k documents that also match the filter query. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or to perform the operation on all indices @@ -2631,7 +2631,7 @@ async def mget( IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. - ``_ + ``_ :param index: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. @@ -2758,7 +2758,7 @@ async def msearch( Each newline character may be preceded by a carriage return `\\r`. When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`. - ``_ + ``_ :param searches: :param index: Comma-separated list of data streams, indices, and index aliases @@ -2890,7 +2890,7 @@ async def msearch_template( """ Run multiple templated searches. - ``_ + ``_ :param search_templates: :param index: Comma-separated list of data streams, indices, and aliases to search. @@ -2989,7 +2989,7 @@ async def mtermvectors( with all the fetched termvectors. Each element has the structure provided by the termvectors API. - ``_ + ``_ :param index: Name of the index that contains the documents. :param docs: Array of existing or artificial documents. @@ -3079,6 +3079,7 @@ async def open_point_in_time( *, index: t.Union[str, t.Sequence[str]], keep_alive: t.Union[str, t.Literal[-1], t.Literal[0]], + allow_partial_search_results: t.Optional[bool] = None, error_trace: t.Optional[bool] = None, expand_wildcards: t.Optional[ t.Union[ @@ -3108,11 +3109,15 @@ async def open_point_in_time( A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. - ``_ + ``_ :param index: A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices :param keep_alive: Extends the time to live of the corresponding point in time. + :param allow_partial_search_results: If `false`, creating a point in time request + when a shard is missing or unavailable will throw an exception. If `true`, + the point in time will contain all the shards that are available at the time + of the request. :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 @@ -3135,6 +3140,8 @@ async def open_point_in_time( __body: t.Dict[str, t.Any] = body if body is not None else {} if keep_alive is not None: __query["keep_alive"] = keep_alive + if allow_partial_search_results is not None: + __query["allow_partial_search_results"] = allow_partial_search_results if error_trace is not None: __query["error_trace"] = error_trace if expand_wildcards is not None: @@ -3190,7 +3197,7 @@ async def put_script( Create or update a script or search template. Creates or updates a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. Must be unique within the cluster. @@ -3276,7 +3283,7 @@ async def rank_eval( Evaluate ranked search results. Evaluate the quality of ranked search results over a set of typical search queries. - ``_ + ``_ :param requests: A set of typical search requests, together with their provided ratings. @@ -3372,7 +3379,7 @@ async def reindex( can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. - ``_ + ``_ :param dest: The destination you are copying to. :param source: The source you are copying from. @@ -3469,7 +3476,7 @@ async def reindex_rethrottle( Throttle a reindex operation. Change the number of requests per second for a particular reindex operation. - ``_ + ``_ :param task_id: Identifier for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -3520,7 +3527,7 @@ async def render_search_template( """ Render a search template. Render a search template as a search request body. - ``_ + ``_ :param id: ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. @@ -3589,7 +3596,7 @@ async def scripts_painless_execute( """ Run a script. Runs a script and returns a result. - ``_ + ``_ :param context: The context that the script should run in. :param context_setup: Additional parameters for the `context`. @@ -3662,7 +3669,7 @@ async def scroll( of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. - ``_ + ``_ :param scroll_id: Scroll ID of the search. :param rest_total_hits_as_int: If true, the API response’s hit.total property @@ -3854,7 +3861,7 @@ async def search( can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -4284,7 +4291,7 @@ async def search_mvt( """ Search a vector tile. Search a vector tile for geospatial values. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, or aliases to search :param field: Field containing geospatial data to return @@ -4441,7 +4448,7 @@ async def search_shards( optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section. - ``_ + ``_ :param index: Returns the indices and shards that a search request would be executed against. @@ -4542,7 +4549,7 @@ 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 (*). @@ -4682,7 +4689,7 @@ async def terms_enum( 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. @@ -4781,7 +4788,7 @@ async def termvectors( Get term vector information. Get information and statistics about terms in the fields of a particular document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -4924,7 +4931,7 @@ async def update( Update a document. Updates a document by running a script or passing a partial document. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -5090,7 +5097,7 @@ async def update_by_query( is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -5289,7 +5296,7 @@ async def update_by_query_rethrottle( 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 0093273ca..c2c3f9526 100644 --- a/elasticsearch/_async/client/async_search.py +++ b/elasticsearch/_async/client/async_search.py @@ -42,7 +42,7 @@ async def delete( 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. """ @@ -90,7 +90,7 @@ async def get( 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 @@ -145,6 +145,7 @@ async def status( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ @@ -153,9 +154,12 @@ async def status( 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. + Ongoing async searches and any saved search results are deleted after this + period. """ if id in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'id'") @@ -168,6 +172,8 @@ async def status( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if keep_alive is not None: + __query["keep_alive"] = keep_alive if pretty is not None: __query["pretty"] = pretty __headers = {"accept": "application/json"} @@ -258,7 +264,6 @@ async def submit( ignore_throttled: t.Optional[bool] = None, ignore_unavailable: t.Optional[bool] = None, indices_boost: t.Optional[t.Sequence[t.Mapping[str, float]]] = None, - keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, keep_on_completion: t.Optional[bool] = None, knn: t.Optional[ t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]] @@ -269,7 +274,6 @@ async def submit( min_score: t.Optional[float] = None, pit: t.Optional[t.Mapping[str, t.Any]] = None, post_filter: t.Optional[t.Mapping[str, t.Any]] = None, - pre_filter_shard_size: t.Optional[int] = None, preference: t.Optional[str] = None, pretty: t.Optional[bool] = None, profile: t.Optional[bool] = None, @@ -283,7 +287,6 @@ async def submit( routing: t.Optional[str] = None, runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None, script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None, - scroll: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, search_after: t.Optional[ t.Sequence[t.Union[None, bool, float, int, str, t.Any]] ] = None, @@ -333,7 +336,7 @@ async def submit( 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 @@ -376,9 +379,6 @@ async def submit( :param ignore_unavailable: Whether specified concrete indices should be ignored when unavailable (missing or closed) :param indices_boost: Boosts the _score of documents from specified indices. - :param keep_alive: Specifies how long the async search needs to be available. - Ongoing async searches and any saved search results are deleted after this - period. :param keep_on_completion: If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. :param knn: Defines the approximate kNN search to run. @@ -394,10 +394,6 @@ async def submit( :param pit: Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path. :param post_filter: - :param pre_filter_shard_size: The default value cannot be changed, which enforces - the execution of a pre-filter roundtrip to retrieve statistics from each - shard so that the ones that surely don’t hold any document matching the query - get skipped. :param preference: Specify the node or shard the operation should be performed on (default: random) :param profile: @@ -406,13 +402,13 @@ async def submit( :param request_cache: Specify if request cache should be used for this request or not, defaults to true :param rescore: - :param rest_total_hits_as_int: + :param rest_total_hits_as_int: Indicates whether hits.total should be rendered + as an integer or an object in the rest search response :param routing: A comma-separated list of specific routing values :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 script_fields: Retrieve a script evaluation (based on different fields) for each hit. - :param scroll: :param search_after: :param search_type: Search operation type :param seq_no_primary_term: If true, returns sequence number and primary term @@ -509,8 +505,6 @@ async def submit( __query["ignore_throttled"] = ignore_throttled if ignore_unavailable is not None: __query["ignore_unavailable"] = ignore_unavailable - if keep_alive is not None: - __query["keep_alive"] = keep_alive if keep_on_completion is not None: __query["keep_on_completion"] = keep_on_completion if lenient is not None: @@ -519,8 +513,6 @@ async def submit( __query["max_concurrent_shard_requests"] = max_concurrent_shard_requests if min_compatible_shard_node is not None: __query["min_compatible_shard_node"] = min_compatible_shard_node - if pre_filter_shard_size is not None: - __query["pre_filter_shard_size"] = pre_filter_shard_size if preference is not None: __query["preference"] = preference if pretty is not None: @@ -533,8 +525,6 @@ async def submit( __query["rest_total_hits_as_int"] = rest_total_hits_as_int if routing is not None: __query["routing"] = routing - if scroll is not None: - __query["scroll"] = scroll if search_type is not None: __query["search_type"] = search_type if source_excludes is not None: diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py index cb2eccabf..82e0e6d8c 100644 --- a/elasticsearch/_async/client/autoscaling.py +++ b/elasticsearch/_async/client/autoscaling.py @@ -33,16 +33,23 @@ async def delete_autoscaling_policy( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, + timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ Delete an 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 + no response is received before the timeout expires, the request fails and + returns an error. + :param timeout: Period to wait for a response. If no response is received before + the timeout expires, the request fails and returns an error. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'name'") @@ -55,8 +62,12 @@ async def delete_autoscaling_policy( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty + if timeout is not None: + __query["timeout"] = timeout __headers = {"accept": "application/json"} return await self.perform_request( # type: ignore[return-value] "DELETE", @@ -74,6 +85,7 @@ async def get_autoscaling_capacity( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ @@ -90,7 +102,11 @@ async def get_autoscaling_capacity( capacity was required. This information is provided for diagnosis only. 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 + returns an error. """ __path_parts: t.Dict[str, str] = {} __path = "/_autoscaling/capacity" @@ -101,6 +117,8 @@ async def get_autoscaling_capacity( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty __headers = {"accept": "application/json"} @@ -121,6 +139,7 @@ async def get_autoscaling_policy( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ @@ -128,9 +147,12 @@ async def get_autoscaling_policy( 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 + no response is received before the timeout expires, the request fails and + returns an error. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'name'") @@ -143,6 +165,8 @@ async def get_autoscaling_policy( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty __headers = {"accept": "application/json"} @@ -167,17 +191,24 @@ async def put_autoscaling_policy( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, + timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ Create or update an 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: + :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 + returns an error. + :param timeout: Period to wait for a response. If no response is received before + the timeout expires, the request fails and returns an error. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'name'") @@ -196,8 +227,12 @@ async def put_autoscaling_policy( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty + if timeout is not None: + __query["timeout"] = timeout __body = policy if policy is not None else body __headers = {"accept": "application/json", "content-type": "application/json"} return await self.perform_request( # type: ignore[return-value] diff --git a/elasticsearch/_async/client/cat.py b/elasticsearch/_async/client/cat.py index 257470b84..be38db139 100644 --- a/elasticsearch/_async/client/cat.py +++ b/elasticsearch/_async/client/cat.py @@ -63,7 +63,7 @@ async def aliases( 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`. @@ -151,7 +151,7 @@ async def allocation( disk space. 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: Comma-separated list of node identifiers or names used to limit the returned information. @@ -238,7 +238,7 @@ async def component_templates( for use by applications. For application consumption, use the get component template API. - ``_ + ``_ :param name: The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned. @@ -322,7 +322,7 @@ async def count( console. They are not intended for use by applications. For application consumption, use the count API. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -408,7 +408,7 @@ async def fielddata( using the command line or Kibana console. 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. @@ -503,7 +503,7 @@ async def health( across multiple nodes. 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`. @@ -580,7 +580,7 @@ async def help( """ Get CAT help. Returns help for the CAT APIs. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -678,7 +678,7 @@ async def indices( using the command line or Kibana console. 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 @@ -780,7 +780,7 @@ async def master( 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`. @@ -955,7 +955,7 @@ async def ml_data_frame_analytics( For 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 @@ -1129,7 +1129,7 @@ async def ml_datafeeds( using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1502,7 +1502,7 @@ async def ml_jobs( for use by applications. For 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 @@ -1691,7 +1691,7 @@ async def ml_trained_models( console or command line. They are not intended for use by applications. For 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 @@ -1788,7 +1788,7 @@ async def nodeattrs( 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`. @@ -1867,7 +1867,7 @@ async def nodes( 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 @@ -1952,7 +1952,7 @@ async def pending_tasks( 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`. @@ -2026,7 +2026,7 @@ async def plugins( 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`. @@ -2110,7 +2110,7 @@ async def recovery( 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 @@ -2202,7 +2202,7 @@ async def repositories( 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`. @@ -2281,7 +2281,7 @@ async def segments( 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 @@ -2370,7 +2370,7 @@ async def shards( 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 @@ -2458,7 +2458,7 @@ async def snapshots( 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. @@ -2549,7 +2549,7 @@ async def tasks( 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 @@ -2639,7 +2639,7 @@ async def templates( 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. @@ -2725,7 +2725,7 @@ async def thread_pool( 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. @@ -2980,7 +2980,7 @@ async def transforms( command line. They are not intended for use by applications. For 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 0cd6c7c4c..38aa2d968 100644 --- a/elasticsearch/_async/client/ccr.py +++ b/elasticsearch/_async/client/ccr.py @@ -38,7 +38,7 @@ async def delete_auto_follow_pattern( """ Deletes auto-follow patterns. - ``_ + ``_ :param name: The name of the auto follow pattern. """ @@ -109,7 +109,7 @@ async def follow( """ Creates a new follower index configured to follow the referenced leader index. - ``_ + ``_ :param index: The name of the follower index :param leader_index: @@ -201,7 +201,7 @@ async def follow_info( Retrieves information about all follower indices, including parameters and status for each follower index - ``_ + ``_ :param index: A comma-separated list of index patterns; use `_all` to perform the operation on all indices @@ -243,7 +243,7 @@ async def follow_stats( Retrieves follower stats. return 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 @@ -296,7 +296,7 @@ async def forget_follower( """ Removes the follower retention leases from the leader. - ``_ + ``_ :param index: the name of the leader index for which specified follower retention leases should be removed @@ -353,7 +353,7 @@ async def get_auto_follow_pattern( Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. - ``_ + ``_ :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. @@ -397,7 +397,7 @@ async def pause_auto_follow_pattern( """ Pauses an auto-follow pattern - ``_ + ``_ :param name: The name of the auto follow pattern that should pause discovering new indices to follow. @@ -439,7 +439,7 @@ async def pause_follow( Pauses a follower index. The follower index will not fetch any additional operations from the leader index. - ``_ + ``_ :param index: The name of the follower index that should pause following its leader index. @@ -516,7 +516,7 @@ async def put_auto_follow_pattern( cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. - ``_ + ``_ :param name: The name of the collection of auto-follow patterns. :param remote_cluster: The remote cluster containing the leader indices to match @@ -640,7 +640,7 @@ async def resume_auto_follow_pattern( """ Resumes an auto-follow pattern that has been paused - ``_ + ``_ :param name: The name of the auto follow pattern to resume discovering new indices to follow. @@ -705,7 +705,7 @@ async def resume_follow( """ Resumes a follower index that has been paused - ``_ + ``_ :param index: The name of the follow index to resume following. :param max_outstanding_read_requests: @@ -787,7 +787,7 @@ async def stats( """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ccr/stats" @@ -824,7 +824,7 @@ async def unfollow( Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. - ``_ + ``_ :param index: The name of the follower index that should be turned into a regular index. diff --git a/elasticsearch/_async/client/cluster.py b/elasticsearch/_async/client/cluster.py index c3f5ec8dc..ec80623c1 100644 --- a/elasticsearch/_async/client/cluster.py +++ b/elasticsearch/_async/client/cluster.py @@ -46,7 +46,7 @@ async def allocation_explain( """ Provides explanations for shard allocations in the cluster. - ``_ + ``_ :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. @@ -117,7 +117,7 @@ async def delete_component_template( 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. @@ -167,7 +167,7 @@ async def delete_voting_config_exclusions( """ Clears cluster voting config exclusions. - ``_ + ``_ :param wait_for_removal: Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions @@ -215,7 +215,7 @@ async def exists_component_template( Check component templates. 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. @@ -270,7 +270,7 @@ async def get_component_template( """ Get component templates. Retrieves information about component templates. - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -334,7 +334,7 @@ async def get_settings( Returns cluster-wide 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 @@ -424,7 +424,7 @@ async def health( by the worst shard status. 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 @@ -528,7 +528,7 @@ async def info( """ Get cluster 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. @@ -577,7 +577,7 @@ async def pending_tasks( 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. @@ -625,7 +625,7 @@ async def post_voting_config_exclusions( """ Updates the cluster voting config exclusions by node ids or node names. - ``_ + ``_ :param node_ids: A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify @@ -700,7 +700,7 @@ async def put_component_template( You can include comments anywhere in the request body except before the opening curly bracket. - ``_ + ``_ :param name: Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; @@ -789,7 +789,7 @@ async def put_settings( """ Updates the cluster settings. - ``_ + ``_ :param flat_settings: Return settings in flat format (default: false) :param master_timeout: Explicit operation timeout for connection to master node @@ -845,7 +845,7 @@ async def remote_info( cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_remote/info" @@ -890,7 +890,7 @@ async def reroute( """ Allows to manually change the allocation of individual shards in the cluster. - ``_ + ``_ :param commands: Defines the commands to perform. :param dry_run: If true, then the request simulates the operation only and returns @@ -977,7 +977,7 @@ async def state( """ Returns a comprehensive information about the state of the cluster. - ``_ + ``_ :param metric: Limit the information returned to the specified metrics :param index: A comma-separated list of index names; use `_all` or empty string @@ -1063,7 +1063,7 @@ async def stats( 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 34d566333..ce63350a1 100644 --- a/elasticsearch/_async/client/connector.py +++ b/elasticsearch/_async/client/connector.py @@ -46,7 +46,7 @@ async def check_in( Check in a connector. 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 """ @@ -91,7 +91,7 @@ async def delete( ingest pipelines, or data indices associated with the connector. 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 @@ -136,7 +136,7 @@ async def get( """ Get a connector. Get the details about a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector """ @@ -232,7 +232,7 @@ async def last_sync( Update the connector last sync stats. Update the fields related to the last sync of a connector. 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: @@ -327,7 +327,7 @@ async def list( """ Get all connectors. Get information about all connectors. - ``_ + ``_ :param connector_name: A comma-separated list of connector names to fetch connector documents for @@ -406,7 +406,7 @@ async def post( a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure. - ``_ + ``_ :param description: :param index_name: @@ -485,7 +485,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. @@ -558,7 +558,7 @@ async def sync_job_cancel( 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 """ @@ -604,7 +604,7 @@ async def sync_job_delete( Delete a connector sync job. Remove a connector sync job and its associated data. 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 @@ -648,7 +648,7 @@ async def sync_job_get( """ Get a connector sync job. - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job """ @@ -718,7 +718,7 @@ async def sync_job_list( Get all connector sync jobs. 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) @@ -781,7 +781,7 @@ async def sync_job_post( Create a connector sync job. 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: @@ -834,7 +834,7 @@ async def update_active_filtering( Activate the connector draft filter. Activates the valid draft filtering for a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated """ @@ -884,7 +884,7 @@ async def update_api_key_id( secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param api_key_id: @@ -940,7 +940,7 @@ async def update_configuration( Update the connector configuration. Update the configuration field in the connector document. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param configuration: @@ -997,7 +997,7 @@ async def update_error( to error. Otherwise, if the error is reset to null, the connector status is updated to connected. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param error: @@ -1055,7 +1055,7 @@ async def update_filtering( is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param advanced_snippet: @@ -1113,7 +1113,7 @@ async def update_filtering_validation( Update the connector draft filtering validation. Update the draft filtering validation info for a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param validation: @@ -1167,7 +1167,7 @@ async def update_index_name( Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param index_name: @@ -1221,7 +1221,7 @@ async def update_name( """ Update the connector name and description. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param description: @@ -1275,7 +1275,7 @@ async def update_native( """ Update the connector is_native flag. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param is_native: @@ -1329,7 +1329,7 @@ async def update_pipeline( Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param pipeline: @@ -1382,7 +1382,7 @@ async def update_scheduling( """ Update the connector scheduling. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param scheduling: @@ -1435,7 +1435,7 @@ async def update_service_type( """ Update the connector service type. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param service_type: @@ -1495,7 +1495,7 @@ async def update_status( """ Update the connector status. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param status: diff --git a/elasticsearch/_async/client/dangling_indices.py b/elasticsearch/_async/client/dangling_indices.py index e5b23d720..50d67d11c 100644 --- a/elasticsearch/_async/client/dangling_indices.py +++ b/elasticsearch/_async/client/dangling_indices.py @@ -44,7 +44,7 @@ async def delete_dangling_index( For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. - ``_ + ``_ :param index_uuid: The UUID of the index to delete. Use the get dangling indices API to find the UUID. @@ -103,7 +103,7 @@ async def import_dangling_index( For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. - ``_ + ``_ :param index_uuid: The UUID of the index to import. Use the get dangling indices API to locate the UUID. @@ -162,7 +162,7 @@ async def list_dangling_indices( indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_dangling" diff --git a/elasticsearch/_async/client/enrich.py b/elasticsearch/_async/client/enrich.py index 6cb22bf26..d6650b4c7 100644 --- a/elasticsearch/_async/client/enrich.py +++ b/elasticsearch/_async/client/enrich.py @@ -38,7 +38,7 @@ async def delete_policy( """ Delete an enrich policy. Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :param name: Enrich policy to delete. """ @@ -77,9 +77,9 @@ async def execute_policy( wait_for_completion: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates the enrich index for an existing enrich policy. + Run an enrich policy. Create the enrich index for an existing enrich policy. - ``_ + ``_ :param name: Enrich policy to execute. :param wait_for_completion: If `true`, the request blocks other enrich policy @@ -123,7 +123,7 @@ async def get_policy( """ Get an enrich policy. Returns information about an enrich policy. - ``_ + ``_ :param name: Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. @@ -173,7 +173,7 @@ async def put_policy( """ Create an enrich policy. Creates an enrich policy. - ``_ + ``_ :param name: Name of the enrich policy to create or update. :param geo_match: Matches enrich data to incoming documents based on a `geo_shape` @@ -227,7 +227,7 @@ async def stats( Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_enrich/_stats" diff --git a/elasticsearch/_async/client/eql.py b/elasticsearch/_async/client/eql.py index e835620fd..dbba23b7a 100644 --- a/elasticsearch/_async/client/eql.py +++ b/elasticsearch/_async/client/eql.py @@ -36,10 +36,10 @@ async def delete( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes an async EQL search or a stored synchronous EQL search. The API also - deletes results for the search. + Delete an async EQL search. Delete an async EQL search or a stored synchronous + EQL search. The API also deletes results for the search. - ``_ + ``_ :param id: Identifier for the search to delete. A search ID is provided in the EQL search API's response for an async search. A search ID is also provided @@ -83,10 +83,10 @@ async def get( ] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status and available results for an async EQL search or a - stored synchronous EQL search. + Get async EQL search results. Get the current status and available results for + an async EQL search or a stored synchronous EQL search. - ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -134,10 +134,10 @@ async def get_status( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status for an async EQL search or a stored synchronous EQL - search without returning results. + Get the async EQL status. Get the current status for an async EQL search or a + stored synchronous EQL search without returning results. - ``_ + ``_ :param id: Identifier for the search. """ @@ -223,9 +223,11 @@ async def search( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns results matching a query expressed in Event Query Language (EQL) + Get EQL search results. Returns search results for an Event Query Language (EQL) + query. EQL assumes each document in a data stream or index corresponds to an + event. - ``_ + ``_ :param index: The name of the index to scope the operation :param query: EQL query you wish to run. diff --git a/elasticsearch/_async/client/esql.py b/elasticsearch/_async/client/esql.py index 68eb37243..1946c2f52 100644 --- a/elasticsearch/_async/client/esql.py +++ b/elasticsearch/_async/client/esql.py @@ -68,9 +68,10 @@ async def query( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Executes an ES|QL request + Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) + query. - ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. diff --git a/elasticsearch/_async/client/features.py b/elasticsearch/_async/client/features.py index 32fecf55a..09b98ecee 100644 --- a/elasticsearch/_async/client/features.py +++ b/elasticsearch/_async/client/features.py @@ -38,7 +38,7 @@ async def get_features( Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features" @@ -74,7 +74,7 @@ async def reset_features( """ Resets the internal state of features, usually by deleting system indices - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features/_reset" diff --git a/elasticsearch/_async/client/fleet.py b/elasticsearch/_async/client/fleet.py index eb05f0352..ba6637b1d 100644 --- a/elasticsearch/_async/client/fleet.py +++ b/elasticsearch/_async/client/fleet.py @@ -49,7 +49,7 @@ async def global_checkpoints( Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. - ``_ + ``_ :param index: A single index or index alias that resolves to a single index. :param checkpoints: A comma separated list of previous global checkpoints. When diff --git a/elasticsearch/_async/client/graph.py b/elasticsearch/_async/client/graph.py index 2ce75e7f2..e713aa26b 100644 --- a/elasticsearch/_async/client/graph.py +++ b/elasticsearch/_async/client/graph.py @@ -45,10 +45,16 @@ async def explore( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Extracts and summarizes information about the documents and terms in an Elasticsearch - data stream or index. + Explore graph analytics. Extract and summarize information about the documents + and terms in an Elasticsearch data stream or index. The easiest way to understand + the behavior of this API is to use the Graph UI to explore connections. An initial + request to the `_explore` API contains a seed query that identifies the documents + of interest and specifies the fields that define the vertices and connections + you want to include in the graph. Subsequent requests enable you to spider out + from one more vertices of interest. You can exclude vertices that have already + been returned. - ``_ + ``_ :param index: Name of the index. :param connections: Specifies or more fields from which you want to extract terms diff --git a/elasticsearch/_async/client/ilm.py b/elasticsearch/_async/client/ilm.py index 66df40190..96c85ae96 100644 --- a/elasticsearch/_async/client/ilm.py +++ b/elasticsearch/_async/client/ilm.py @@ -42,7 +42,7 @@ async def delete_lifecycle( that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -97,7 +97,7 @@ async def explain_lifecycle( currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -159,7 +159,7 @@ async def get_lifecycle( """ Retrieves a lifecycle policy. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -210,7 +210,7 @@ async def get_status( """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ilm/status" @@ -254,7 +254,7 @@ async def migrate_to_data_tiers( data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers. - ``_ + ``_ :param dry_run: If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides @@ -314,7 +314,7 @@ async def move_to_step( """ Manually moves an index into the specified step and executes that step. - ``_ + ``_ :param index: The name of the index whose lifecycle step is to change :param current_step: @@ -378,7 +378,7 @@ async def put_lifecycle( Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -437,7 +437,7 @@ async def remove_policy( """ Removes the assigned lifecycle policy and stops managing the specified index - ``_ + ``_ :param index: The name of the index to remove policy on """ @@ -477,7 +477,7 @@ async def retry( """ Retries executing the policy for an index that is in the ERROR step. - ``_ + ``_ :param index: The name of the indices (comma-separated) whose failed lifecycle step is to be retry @@ -519,7 +519,7 @@ async def start( """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ :param master_timeout: :param timeout: @@ -564,7 +564,7 @@ async def stop( Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin - ``_ + ``_ :param master_timeout: :param timeout: diff --git a/elasticsearch/_async/client/indices.py b/elasticsearch/_async/client/indices.py index e884cd8ff..f4326c65d 100644 --- a/elasticsearch/_async/client/indices.py +++ b/elasticsearch/_async/client/indices.py @@ -58,7 +58,7 @@ async def add_block( Add an index block. Limits the operations allowed on an index by blocking specific operation types. - ``_ + ``_ :param index: A comma separated list of indices to add a block to :param block: The block to add (one of read, write, read_only or metadata) @@ -146,7 +146,7 @@ async def analyze( Get tokens from text analysis. The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens. - ``_ + ``_ :param index: Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the @@ -248,7 +248,7 @@ async def clear_cache( Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -333,7 +333,7 @@ async def clone( """ Clones an existing index. - ``_ + ``_ :param index: Name of the source index to clone. :param target: Name of the target index to create. @@ -421,7 +421,7 @@ async def close( """ Closes an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -502,7 +502,7 @@ async def create( """ Create an index. Creates a new index. - ``_ + ``_ :param index: Name of the index you wish to create. :param aliases: Aliases for the index. @@ -576,7 +576,7 @@ async def create_data_stream( Create a data stream. Creates a data stream. You must have a matching index template with data stream enabled. - ``_ + ``_ :param name: Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, @@ -637,7 +637,7 @@ async def data_streams_stats( """ Get data stream stats. Retrieves statistics for one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a @@ -698,7 +698,7 @@ async def delete( """ Delete indices. Deletes one or more indices. - ``_ + ``_ :param index: Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. @@ -768,7 +768,7 @@ async def delete_alias( """ Delete an alias. Removes a data stream or index from an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). @@ -833,7 +833,7 @@ async def delete_data_lifecycle( Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. - ``_ + ``_ :param name: A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams @@ -893,7 +893,7 @@ async def delete_data_stream( """ Delete data streams. Deletes one or more data streams and their backing indices. - ``_ + ``_ :param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. @@ -948,7 +948,7 @@ async def delete_index_template( then there is no wildcard support and the provided names should match completely with existing templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1000,7 +1000,7 @@ async def delete_template( """ Deletes a legacy index template. - ``_ + ``_ :param name: The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. @@ -1063,7 +1063,7 @@ async def disk_usage( """ Analyzes the disk usage of each field of an index or data stream. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single @@ -1139,7 +1139,7 @@ async def downsample( (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. - ``_ + ``_ :param index: Name of the time series index to downsample. :param target_index: Name of the index to create. @@ -1208,7 +1208,7 @@ async def exists( Check indices. Checks if one or more indices, index aliases, or data streams exist. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1286,7 +1286,7 @@ async def exists_alias( """ Check aliases. Checks if one or more data stream or index aliases exist. - ``_ + ``_ :param name: Comma-separated list of aliases to check. Supports wildcards (`*`). :param index: Comma-separated list of data streams or indices used to limit the @@ -1354,9 +1354,9 @@ async def exists_index_template( pretty: t.Optional[bool] = None, ) -> HeadApiResponse: """ - Returns information about whether a particular index template exists. + Check index templates. Check whether index templates exist. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1406,7 +1406,7 @@ async def exists_template( Check existence of index templates. Returns information about whether a particular index template exists. - ``_ + ``_ :param name: The comma separated names of the index templates :param flat_settings: Return settings in flat format (default: false) @@ -1461,7 +1461,7 @@ async def explain_data_lifecycle( creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. - ``_ + ``_ :param index: The name of the index to explain :param include_defaults: indicates if the API should return the default values @@ -1525,7 +1525,7 @@ async def field_usage_stats( """ Returns field usage information for each shard and field of an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1613,7 +1613,7 @@ async def flush( """ Flushes one or more data streams or indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this @@ -1696,7 +1696,7 @@ async def forcemerge( """ Performs the force merge operation on one or more indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1790,7 +1790,7 @@ async def get( Get index information. Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -1879,7 +1879,7 @@ async def get_alias( """ Get aliases. Retrieves information for one or more data stream or index aliases. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, @@ -1962,7 +1962,7 @@ async def get_data_lifecycle( Get data stream lifecycles. Retrieves the data stream lifecycle configuration of one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` @@ -2028,7 +2028,7 @@ async def get_data_stream( """ Get data streams. Retrieves information about one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are @@ -2104,7 +2104,7 @@ async def get_field_mapping( Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. - ``_ + ``_ :param fields: Comma-separated list or wildcard expression of fields used to limit returned information. @@ -2181,7 +2181,7 @@ async def get_index_template( """ Get index templates. Returns information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2255,7 +2255,7 @@ async def get_mapping( Get mapping definitions. Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2340,7 +2340,7 @@ async def get_settings( Get index settings. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2427,7 +2427,7 @@ async def get_template( """ Get index templates. Retrieves information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, @@ -2493,7 +2493,7 @@ async def migrate_to_data_stream( with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream. - ``_ + ``_ :param name: Name of the index alias to convert to a data stream. :param master_timeout: Period to wait for a connection to the master node. If @@ -2546,7 +2546,7 @@ async def modify_data_stream( Update data streams. Performs one or more data stream modification actions in a single atomic operation. - ``_ + ``_ :param actions: Actions to perform. """ @@ -2606,7 +2606,7 @@ async def open( """ Opens a closed index. For data streams, the API opens any closed backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly @@ -2682,7 +2682,7 @@ async def promote_data_stream( Promotes a data stream from a replicated data stream managed by CCR to a regular data stream - ``_ + ``_ :param name: The name of the data stream :param master_timeout: Period to wait for a connection to the master node. If @@ -2744,7 +2744,7 @@ async def put_alias( """ Create or update an alias. Adds a data stream or index to an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices @@ -2847,7 +2847,7 @@ async def put_data_lifecycle( Update data stream lifecycles. Update the data stream lifecycle of the specified data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`. @@ -2949,7 +2949,7 @@ async def put_index_template( Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: Index or template name :param allow_auto_create: This setting overrides the value of the `action.auto_create_index` @@ -3110,7 +3110,7 @@ async def put_mapping( can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default. - ``_ + ``_ :param index: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. @@ -3240,7 +3240,7 @@ async def put_settings( Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. - ``_ + ``_ :param settings: :param index: Comma-separated list of data streams, indices, and aliases used @@ -3345,7 +3345,7 @@ async def put_template( Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -3427,7 +3427,7 @@ async def recovery( indices. For data streams, the API returns information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3491,7 +3491,7 @@ async def refresh( indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3561,7 +3561,7 @@ async def reload_search_analyzers( """ Reloads an index's search analyzers and their resources. - ``_ + ``_ :param index: A comma-separated list of index names to reload analyzers for :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -3627,7 +3627,7 @@ async def resolve_cluster( including the local cluster, if included. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3698,10 +3698,10 @@ async def resolve_index( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Resolves the specified name(s) and/or index patterns for indices, aliases, and - data streams. Multiple patterns and remote clusters are supported. + Resolve indices. Resolve the names and/or index patterns for indices, aliases, + and data streams. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3774,7 +3774,7 @@ async def rollover( """ Roll over to a new index. Creates a new index for a data stream or index alias. - ``_ + ``_ :param alias: Name of the data stream or index alias to roll over. :param new_index: Name of the index to create. Supports date math. Data streams @@ -3880,7 +3880,7 @@ async def segments( Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3960,7 +3960,7 @@ async def shard_stores( Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices. - ``_ + ``_ :param index: List of data streams, indices, and aliases used to limit the request. :param allow_no_indices: If false, the request returns an error if any wildcard @@ -4031,7 +4031,7 @@ async def shrink( """ Shrinks an existing index into a new index with fewer primary shards. - ``_ + ``_ :param index: Name of the source index to shrink. :param target: Name of the target index to create. @@ -4107,7 +4107,7 @@ async def simulate_index_template( Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template. - ``_ + ``_ :param name: Name of the index to simulate :param include_defaults: If true, returns all relevant default configurations @@ -4185,7 +4185,7 @@ async def simulate_template( Simulate an index template. Returns the index configuration that would be applied by a particular index template. - ``_ + ``_ :param name: Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template @@ -4316,7 +4316,7 @@ async def split( """ Splits an existing index into a new index with more primary shards. - ``_ + ``_ :param index: Name of the source index to split. :param target: Name of the target index to create. @@ -4409,7 +4409,7 @@ async def stats( Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -4512,7 +4512,7 @@ async def unfreeze( """ Unfreezes an index. - ``_ + ``_ :param index: Identifier for the index. :param allow_no_indices: If `false`, the request returns an error if any wildcard @@ -4586,7 +4586,7 @@ async def update_aliases( """ Create or update an alias. Adds a data stream or index to an alias. - ``_ + ``_ :param actions: Actions to perform. :param master_timeout: Period to wait for a connection to the master node. If @@ -4661,7 +4661,7 @@ async def validate_query( """ Validate a query. Validates a query without running it. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this diff --git a/elasticsearch/_async/client/inference.py b/elasticsearch/_async/client/inference.py index a3ddb1628..860430d87 100644 --- a/elasticsearch/_async/client/inference.py +++ b/elasticsearch/_async/client/inference.py @@ -20,19 +20,12 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import ( - SKIP_IN_PATH, - Stability, - _quote, - _rewrite_parameters, - _stability_warning, -) +from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters class InferenceClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) async def delete( self, *, @@ -53,7 +46,7 @@ async def delete( """ Delete an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param task_type: The task type @@ -100,7 +93,6 @@ async def delete( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) async def get( self, *, @@ -119,7 +111,7 @@ async def get( """ Get an inference endpoint - ``_ + ``_ :param task_type: The task type :param inference_id: The inference Id @@ -159,7 +151,6 @@ async def get( @_rewrite_parameters( body_fields=("input", "query", "task_settings"), ) - @_stability_warning(Stability.EXPERIMENTAL) async def inference( self, *, @@ -183,7 +174,7 @@ async def inference( """ Perform inference on the service - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -246,7 +237,6 @@ async def inference( @_rewrite_parameters( body_name="inference_config", ) - @_stability_warning(Stability.EXPERIMENTAL) async def put( self, *, @@ -267,7 +257,7 @@ async def put( """ Create an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param inference_config: diff --git a/elasticsearch/_async/client/ingest.py b/elasticsearch/_async/client/ingest.py index 0d78dc03c..c2fe6e688 100644 --- a/elasticsearch/_async/client/ingest.py +++ b/elasticsearch/_async/client/ingest.py @@ -38,9 +38,10 @@ async def delete_geoip_database( timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a geoip database configuration. + Delete GeoIP database configurations. Delete one or more IP geolocation database + configurations. - ``_ + ``_ :param id: A comma-separated list of geoip database configurations to delete :param master_timeout: Period to wait for a connection to the master node. If @@ -89,9 +90,9 @@ async def delete_pipeline( timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes one or more existing ingest pipeline. + Delete pipelines. Delete one or more ingest pipelines. - ``_ + ``_ :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. @@ -138,9 +139,10 @@ async def geo_ip_stats( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Gets download statistics for GeoIP2 databases used with the geoip processor. + Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used + with the GeoIP processor. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/geoip/stats" @@ -175,9 +177,10 @@ async def get_geoip_database( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more geoip database configurations. + Get GeoIP database configurations. Get information about one or more IP geolocation + database configurations. - ``_ + ``_ :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit @@ -227,10 +230,10 @@ async def get_pipeline( summary: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more ingest pipelines. This API returns a local - reference of the pipeline. + Get pipelines. Get information about one or more ingest pipelines. This API returns + a local reference of the pipeline. - ``_ + ``_ :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. @@ -279,12 +282,12 @@ async def processor_grok( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Extracts structured fields out of a single text field within a document. You - choose which field to extract matched fields from, as well as the grok pattern - you expect will match. A grok pattern is like a regular expression that supports - aliased expressions that can be reused. + Run a grok processor. Extract structured fields out of a single text field within + a document. You must choose which field to extract matched fields from, as well + as the grok pattern you expect will match. A grok pattern is like a regular expression + that supports aliased expressions that can be reused. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/processor/grok" @@ -325,9 +328,10 @@ async def put_geoip_database( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more geoip database configurations. + Create or update GeoIP database configurations. Create or update IP geolocation + database configurations. - ``_ + ``_ :param id: ID of the database configuration to create or update. :param maxmind: The configuration necessary to identify which IP geolocation @@ -411,10 +415,9 @@ async def put_pipeline( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates an ingest pipeline. Changes made using this API take effect - immediately. + Create or update a pipeline. Changes made using this API take effect immediately. - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param deprecated: Marks this ingest pipeline as deprecated. When a deprecated @@ -504,9 +507,11 @@ async def simulate( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Executes an ingest pipeline against a set of provided documents. + Simulate a pipeline. Run an ingest pipeline against a set of provided documents. + You can either specify an existing pipeline to use with the provided documents + or supply a pipeline definition in the body of the request. - ``_ + ``_ :param docs: Sample documents to test in the pipeline. :param id: Pipeline to test. If you don’t specify a `pipeline` in the request diff --git a/elasticsearch/_async/client/license.py b/elasticsearch/_async/client/license.py index fd9f0957c..0f4a209cd 100644 --- a/elasticsearch/_async/client/license.py +++ b/elasticsearch/_async/client/license.py @@ -37,7 +37,7 @@ async def delete( """ Deletes licensing information for the cluster - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license" @@ -76,7 +76,7 @@ async def get( its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -122,7 +122,7 @@ async def get_basic_status( """ Retrieves information about the status of the basic license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/basic_status" @@ -157,7 +157,7 @@ async def get_trial_status( """ Retrieves information about the status of the trial license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/trial_status" @@ -198,7 +198,7 @@ async def post( """ Updates the license for the cluster. - ``_ + ``_ :param acknowledge: Specifies whether you acknowledge the license changes. :param license: @@ -257,7 +257,7 @@ async def post_start_basic( acknowledge parameter set to true. To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -300,7 +300,7 @@ async def post_start_trial( The start trial API enables you to start a 30-day trial, which gives access to all subscription features. - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/_async/client/logstash.py b/elasticsearch/_async/client/logstash.py index c25a79bdd..8701d0cb5 100644 --- a/elasticsearch/_async/client/logstash.py +++ b/elasticsearch/_async/client/logstash.py @@ -38,7 +38,7 @@ async def delete_pipeline( """ Deletes a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. """ @@ -78,7 +78,7 @@ async def get_pipeline( """ Retrieves pipelines used for Logstash Central Management. - ``_ + ``_ :param id: Comma-separated list of pipeline identifiers. """ @@ -125,7 +125,7 @@ async def put_pipeline( """ Creates or updates a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. :param pipeline: diff --git a/elasticsearch/_async/client/migration.py b/elasticsearch/_async/client/migration.py index f73dff7c3..8faacb577 100644 --- a/elasticsearch/_async/client/migration.py +++ b/elasticsearch/_async/client/migration.py @@ -40,7 +40,7 @@ async def deprecations( that use deprecated features that will be removed or changed in the next major version. - ``_ + ``_ :param index: Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. @@ -83,7 +83,7 @@ async def get_feature_upgrade_status( """ Find out whether system features need to be upgraded or not - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" @@ -118,7 +118,7 @@ async def post_feature_upgrade( """ Begin upgrades for system features - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" diff --git a/elasticsearch/_async/client/ml.py b/elasticsearch/_async/client/ml.py index da3a23b1c..dd1befecf 100644 --- a/elasticsearch/_async/client/ml.py +++ b/elasticsearch/_async/client/ml.py @@ -42,7 +42,7 @@ async def clear_trained_model_deployment_cache( may be cached on that individual node. Calling this API clears the caches without restarting the deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -102,7 +102,7 @@ async def close_job( force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection @@ -164,7 +164,7 @@ async def delete_calendar( Delete a calendar. Removes all scheduled events from a calendar, then deletes it. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -205,7 +205,7 @@ async def delete_calendar_event( """ Delete events from a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param event_id: Identifier for the scheduled event. You can obtain this identifier @@ -253,7 +253,7 @@ async def delete_calendar_job( """ Delete anomaly jobs from a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -302,7 +302,7 @@ async def delete_data_frame_analytics( """ Delete a data frame analytics job. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param force: If `true`, it deletes a job that is not stopped; this method is @@ -350,7 +350,7 @@ async def delete_datafeed( """ Delete a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -408,7 +408,7 @@ async def delete_expired_data( expired data for all anomaly detection jobs by using _all, by specifying * as the , or by omitting the . - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -469,7 +469,7 @@ async def delete_filter( delete the filter. You must update or delete the job before you can delete the filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -515,7 +515,7 @@ async def delete_forecast( in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -587,7 +587,7 @@ async def delete_job( delete datafeed API with the same timeout and force parameters as the delete job request. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param delete_user_annotations: Specifies whether annotations that have been @@ -643,7 +643,7 @@ async def delete_model_snapshot( that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -691,7 +691,7 @@ async def delete_trained_model( Delete an unreferenced trained model. The request deletes a trained inference model that is not referenced by an ingest pipeline. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param force: Forcefully deletes a trained model that is referenced by ingest @@ -738,7 +738,7 @@ async def delete_trained_model_alias( to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -795,7 +795,7 @@ async def estimate_model_memory( an anomaly detection job model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references. - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -863,7 +863,7 @@ async def evaluate_data_frame( for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -943,7 +943,7 @@ async def explain_data_frame_analytics( setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -1050,7 +1050,7 @@ async def flush_job( and persists the model state to disk and the job must be opened again before analyzing further data. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -1121,7 +1121,7 @@ async def forecast( for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -1204,7 +1204,7 @@ async def get_buckets( Get anomaly detection job results for buckets. The API presents a chronological view of the records, grouped by bucket. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1299,7 +1299,7 @@ async def get_calendar_events( """ Get info about events in calendars. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1365,7 +1365,7 @@ async def get_calendars( """ Get calendar configuration info. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1438,7 +1438,7 @@ async def get_categories( """ Get anomaly detection job results for categories. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param category_id: Identifier for the category, which is unique in the job. @@ -1522,7 +1522,7 @@ async def get_data_frame_analytics( multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1594,7 +1594,7 @@ async def get_data_frame_analytics_stats( """ Get data frame analytics jobs usage info. - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1664,7 +1664,7 @@ async def get_datafeed_stats( the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1724,7 +1724,7 @@ async def get_datafeeds( `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1787,7 +1787,7 @@ async def get_filters( """ Get filters. You can get a single filter or all filters. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1851,7 +1851,7 @@ async def get_influencers( that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -1932,7 +1932,7 @@ async def get_job_stats( """ Get anomaly detection jobs usage info. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. If @@ -1993,7 +1993,7 @@ async def get_jobs( detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these @@ -2056,7 +2056,7 @@ async def get_memory_stats( jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -2111,7 +2111,7 @@ async def get_model_snapshot_upgrade_stats( """ Get anomaly detection job model snapshot upgrade usage info. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2182,7 +2182,7 @@ async def get_model_snapshots( """ Get model snapshots info. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2295,7 +2295,7 @@ async def get_overall_buckets( its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. @@ -2400,7 +2400,7 @@ async def get_records( found in each bucket, which relates to the number of time series being modeled and the number of detectors. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2495,7 +2495,7 @@ async def get_trained_models( """ Get trained model configuration info. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request @@ -2579,7 +2579,7 @@ async def get_trained_models_stats( models in a single API request by using a comma-separated list of model IDs or a wildcard expression. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. @@ -2642,7 +2642,7 @@ async def infer_trained_model( """ Evaluate a trained model. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param docs: An array of objects to pass to the model for inference. The objects @@ -2704,7 +2704,7 @@ async def info( what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ml/info" @@ -2749,7 +2749,7 @@ async def open_job( job is ready to resume its analysis from where it left off, once new data is received. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2803,7 +2803,7 @@ async def post_calendar_events( """ Add scheduled events to the calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param events: A list of one of more scheduled events. The event’s start and @@ -2861,7 +2861,7 @@ async def post_data( data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -2925,7 +2925,7 @@ async def preview_data_frame_analytics( Preview features used by data frame analytics. Previews the extracted features used by a data frame analytics config. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param config: A data frame analytics config as described in create data frame @@ -2995,7 +2995,7 @@ async def preview_datafeed( that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3071,7 +3071,7 @@ async def put_calendar( """ Create a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -3125,7 +3125,7 @@ async def put_calendar_job( """ Add anomaly detection job to calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -3199,7 +3199,7 @@ async def put_data_frame_analytics( that performs an analysis on the source indices and stores the outcome in a destination index. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3377,7 +3377,7 @@ async def put_datafeed( directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3532,7 +3532,7 @@ async def put_filter( more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3619,7 +3619,7 @@ async def put_job( Create an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index. - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -3800,7 +3800,7 @@ async def put_trained_model( Create a trained model. Enable you to supply a trained model that is not created by data frame analytics. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param compressed_definition: The compressed (GZipped and Base64 encoded) inference @@ -3914,7 +3914,7 @@ async def put_trained_model_alias( common between the old and new trained models for the model alias, the API returns a warning. - ``_ + ``_ :param model_id: The identifier for the trained model that the alias refers to. :param model_alias: The alias to create or update. This value cannot end in numbers. @@ -3972,7 +3972,7 @@ async def put_trained_model_definition_part( """ Create part of a trained model definition. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param part: The definition part number. When the definition is loaded for inference @@ -4051,7 +4051,7 @@ async def put_trained_model_vocabulary( processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -4109,7 +4109,7 @@ async def reset_job( job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. - ``_ + ``_ :param job_id: The ID of the job to reset. :param delete_user_annotations: Specifies whether annotations that have been @@ -4169,7 +4169,7 @@ async def revert_model_snapshot( For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -4239,7 +4239,7 @@ async def set_upgrade_mode( the current value for the upgrade_mode setting by using the get machine learning info API. - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -4294,7 +4294,7 @@ async def start_data_frame_analytics( exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4356,7 +4356,7 @@ async def start_datafeed( headers when you created or updated the datafeed, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4426,7 +4426,7 @@ async def start_trained_model_deployment( Start a trained model deployment. It allocates the model to every machine learning node. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -4510,7 +4510,7 @@ async def stop_data_frame_analytics( Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4576,7 +4576,7 @@ async def stop_datafeed( Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a @@ -4638,7 +4638,7 @@ async def stop_trained_model_deployment( """ Stop a trained model deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -4703,7 +4703,7 @@ async def update_data_frame_analytics( """ Update a data frame analytics job. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4815,7 +4815,7 @@ async def update_datafeed( query using those same roles. If you provide secondary authorization headers, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4979,7 +4979,7 @@ async def update_filter( Update a filter. Updates the description of a filter, adds items, or removes items from the list. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -5070,7 +5070,7 @@ async def update_job( Update an anomaly detection job. Updates certain properties of an anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the job. :param allow_lazy_open: Advanced configuration option. Specifies whether this @@ -5198,7 +5198,7 @@ async def update_model_snapshot( """ Update a snapshot. Updates certain properties of a snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -5259,7 +5259,7 @@ async def update_trained_model_deployment( """ Update a trained model deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -5325,7 +5325,7 @@ async def upgrade_job_snapshot( a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -5401,7 +5401,7 @@ async def validate( """ Validates an anomaly detection job. - ``_ + ``_ :param analysis_config: :param analysis_limits: @@ -5471,7 +5471,7 @@ async def validate_detector( """ Validates an anomaly detection detector. - ``_ + ``_ :param detector: """ diff --git a/elasticsearch/_async/client/monitoring.py b/elasticsearch/_async/client/monitoring.py index e5eeacc3a..c5c13d77b 100644 --- a/elasticsearch/_async/client/monitoring.py +++ b/elasticsearch/_async/client/monitoring.py @@ -44,7 +44,7 @@ async def bulk( """ Used by the monitoring features to send monitoring data. - ``_ + ``_ :param interval: Collection interval (e.g., '10s' or '10000ms') of the payload :param operations: diff --git a/elasticsearch/_async/client/nodes.py b/elasticsearch/_async/client/nodes.py index a7b516588..21ca60964 100644 --- a/elasticsearch/_async/client/nodes.py +++ b/elasticsearch/_async/client/nodes.py @@ -47,7 +47,7 @@ async def clear_repositories_metering_archive( You can use this API to clear the archived repositories metering information in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -100,7 +100,7 @@ async def get_repositories_metering_info( compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it won’t be present after node restarts. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -154,7 +154,7 @@ async def hot_threads( This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node’s top hot threads. - ``_ + ``_ :param node_id: List of node IDs or names used to limit returned information. :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket @@ -229,7 +229,7 @@ async def info( """ Returns cluster nodes information. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -298,7 +298,7 @@ async def reload_secure_settings( """ Reloads the keystore on nodes in the cluster. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. :param secure_settings_password: The password for the Elasticsearch keystore. @@ -369,7 +369,7 @@ async def stats( """ Returns cluster nodes statistics. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -486,7 +486,7 @@ async def usage( """ Returns information on the usage of features. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting diff --git a/elasticsearch/_async/client/query_rules.py b/elasticsearch/_async/client/query_rules.py index cbf39e121..7b0d2de0b 100644 --- a/elasticsearch/_async/client/query_rules.py +++ b/elasticsearch/_async/client/query_rules.py @@ -37,9 +37,9 @@ async def delete_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a query rule within a query ruleset. + Delete a query rule. Delete a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to delete @@ -85,9 +85,9 @@ async def delete_ruleset( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a query ruleset. + Delete a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to delete """ @@ -126,9 +126,9 @@ async def get_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the details about a query rule within a query ruleset + Get a query rule. Get details about a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to retrieve @@ -174,9 +174,9 @@ async def get_ruleset( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the details about a query ruleset + Get a query ruleset. Get details about a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset """ @@ -217,9 +217,9 @@ async def list_rulesets( size: t.Optional[int] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns summarized information about existing query rulesets. + Get all query rulesets. Get summarized information about the query rulesets. - ``_ + ``_ :param from_: Starting offset (default: 0) :param size: specifies a max number of results to get @@ -270,9 +270,9 @@ async def put_rule( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a query rule within a query ruleset. + Create or update a query rule. Create or update a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to be created or updated @@ -345,9 +345,9 @@ async def put_ruleset( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a query ruleset. + Create or update a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated @@ -398,9 +398,10 @@ async def test( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a query ruleset. + Test a query ruleset. Evaluate match criteria against a query ruleset to identify + the rules that would match that criteria. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated diff --git a/elasticsearch/_async/client/rollup.py b/elasticsearch/_async/client/rollup.py index 154090dd2..5ecd9308c 100644 --- a/elasticsearch/_async/client/rollup.py +++ b/elasticsearch/_async/client/rollup.py @@ -45,7 +45,7 @@ async def delete_job( """ Deletes an existing rollup job. - ``_ + ``_ :param id: Identifier for the job. """ @@ -86,7 +86,7 @@ async def get_jobs( """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :param id: Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. @@ -132,7 +132,7 @@ async def get_rollup_caps( Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - ``_ + ``_ :param id: Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. @@ -178,7 +178,7 @@ async def get_rollup_index_caps( Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). - ``_ + ``_ :param index: Data stream or index to check for rollup capabilities. Wildcard (`*`) expressions are supported. @@ -241,7 +241,7 @@ async def put_job( """ Creates a rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the data that is associated with the rollup job. @@ -358,7 +358,7 @@ async def rollup_search( """ Enables searching rolled-up data using the standard Query DSL. - ``_ + ``_ :param index: Enables searching rolled-up data using the standard Query DSL. :param aggregations: Specifies aggregations. @@ -422,7 +422,7 @@ async def start_job( """ Starts an existing, stopped rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. """ @@ -465,7 +465,7 @@ async def stop_job( """ Stops an existing, started rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum) diff --git a/elasticsearch/_async/client/search_application.py b/elasticsearch/_async/client/search_application.py index b8462f575..984200467 100644 --- a/elasticsearch/_async/client/search_application.py +++ b/elasticsearch/_async/client/search_application.py @@ -46,7 +46,7 @@ async def delete( Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed. - ``_ + ``_ :param name: The name of the search application to delete """ @@ -88,7 +88,7 @@ async def delete_behavioral_analytics( Delete a behavioral analytics collection. The associated data stream is also deleted. - ``_ + ``_ :param name: The name of the analytics collection to be deleted """ @@ -129,7 +129,7 @@ async def get( """ Get search application details. - ``_ + ``_ :param name: The name of the search application """ @@ -170,7 +170,7 @@ async def get_behavioral_analytics( """ Get behavioral analytics collections. - ``_ + ``_ :param name: A list of analytics collections to limit the returned information """ @@ -218,7 +218,7 @@ async def list( """ Returns the existing search applications. - ``_ + ``_ :param from_: Starting offset. :param q: Query in the Lucene query string syntax. @@ -270,7 +270,7 @@ async def put( """ Create or update a search application. - ``_ + ``_ :param name: The name of the search application to be created or updated. :param search_application: @@ -324,7 +324,7 @@ async def put_behavioral_analytics( """ Create a behavioral analytics collection. - ``_ + ``_ :param name: The name of the analytics collection to be created or updated. """ @@ -374,7 +374,7 @@ async def search( the search application or default template. Unspecified template parameters are assigned their default values if applicable. - ``_ + ``_ :param name: The name of the search application to be searched. :param params: Query parameters specific to this request, which will override diff --git a/elasticsearch/_async/client/searchable_snapshots.py b/elasticsearch/_async/client/searchable_snapshots.py index 092e29ede..798a32c11 100644 --- a/elasticsearch/_async/client/searchable_snapshots.py +++ b/elasticsearch/_async/client/searchable_snapshots.py @@ -46,7 +46,7 @@ async def cache_stats( """ Retrieve node-level cache statistics about searchable snapshots. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting @@ -105,7 +105,7 @@ async def clear_cache( """ Clear the cache of searchable snapshots. - ``_ + ``_ :param index: A comma-separated list of index names :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -177,7 +177,7 @@ async def mount( """ Mount a snapshot as a searchable index. - ``_ + ``_ :param repository: The name of the repository containing the snapshot of the index to mount @@ -257,7 +257,7 @@ async def stats( """ Retrieve shard-level statistics about searchable snapshots. - ``_ + ``_ :param index: A comma-separated list of index names :param level: Return stats aggregated at cluster, index or shard level diff --git a/elasticsearch/_async/client/security.py b/elasticsearch/_async/client/security.py index f7e3d7ff7..8242ff57e 100644 --- a/elasticsearch/_async/client/security.py +++ b/elasticsearch/_async/client/security.py @@ -47,7 +47,7 @@ async def activate_user_profile( Activate a user profile. Create or update a user profile on behalf of another user. - ``_ + ``_ :param grant_type: :param access_token: @@ -105,7 +105,7 @@ async def authenticate( and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/_authenticate" @@ -149,7 +149,7 @@ async def bulk_delete_role( manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files. - ``_ + ``_ :param names: An array of role names to delete :param refresh: If `true` (the default) then refresh the affected shards to make @@ -207,7 +207,7 @@ async def bulk_put_role( way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. - ``_ + ``_ :param roles: A dictionary of role name to RoleDescriptor objects to add or update :param refresh: If `true` (the default) then refresh the affected shards to make @@ -266,7 +266,7 @@ async def change_password( Change passwords. Change the passwords of users in the native realm and built-in users. - ``_ + ``_ :param username: The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user. @@ -329,7 +329,7 @@ async def clear_api_key_cache( Clear the API key cache. Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. - ``_ + ``_ :param ids: Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns. @@ -372,7 +372,7 @@ async def clear_cached_privileges( cache. The cache is also automatically cleared for applications that have their privileges updated. - ``_ + ``_ :param application: A comma-separated list of application names """ @@ -414,7 +414,7 @@ async def clear_cached_realms( Clear the user cache. Evict users from the user cache. You can completely clear the cache or evict specific users. - ``_ + ``_ :param realms: Comma-separated list of realms to clear :param usernames: Comma-separated list of usernames to clear from the cache @@ -457,7 +457,7 @@ async def clear_cached_roles( """ Clear the roles cache. Evict roles from the native role cache. - ``_ + ``_ :param name: Role name """ @@ -500,7 +500,7 @@ async def clear_cached_service_tokens( Clear service account token caches. Evict a subset of all entries from the service account token caches. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -563,7 +563,7 @@ async def create_api_key( for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param expiration: Expiration time for the API key. By default, API keys never expire. @@ -650,7 +650,7 @@ async def create_cross_cluster_api_key( API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. - ``_ + ``_ :param access: The access to be granted to this API key. The access is composed of permissions for cross-cluster search and cross-cluster replication. At @@ -720,7 +720,7 @@ async def create_service_token( Create a service account token. Create a service accounts token for access without requiring basic authentication. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -790,7 +790,7 @@ async def delete_privileges( """ Delete application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -846,7 +846,7 @@ async def delete_role( """ Delete roles. Delete roles in the native realm. - ``_ + ``_ :param name: Role name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -894,7 +894,7 @@ async def delete_role_mapping( """ Delete role mappings. - ``_ + ``_ :param name: Role-mapping name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -945,7 +945,7 @@ async def delete_service_token( Delete service account tokens. Delete service account tokens for a service in a specified namespace. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -1003,7 +1003,7 @@ async def delete_user( """ Delete users. Delete users from the native realm. - ``_ + ``_ :param username: username :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1051,7 +1051,7 @@ async def disable_user( """ Disable users. Disable users in the native realm. - ``_ + ``_ :param username: The username of the user to disable :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1100,7 +1100,7 @@ async def disable_user_profile( Disable a user profile. Disable user profiles so that they are not visible in user profile searches. - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1148,7 +1148,7 @@ async def enable_user( """ Enable users. Enable users in the native realm. - ``_ + ``_ :param username: The username of the user to enable :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1197,7 +1197,7 @@ async def enable_user_profile( Enable a user profile. Enable user profiles to make them visible in user profile searches. - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1242,7 +1242,7 @@ async def enroll_kibana( Enroll Kibana. Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/kibana" @@ -1278,7 +1278,7 @@ async def enroll_node( Enroll a node. Enroll a new node to allow it to join an existing cluster with security features enabled. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/node" @@ -1325,7 +1325,7 @@ async def get_api_key( privileges (including `manage_security`), this API returns all API keys regardless of ownership. - ``_ + ``_ :param active_only: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, @@ -1400,7 +1400,7 @@ async def get_builtin_privileges( Get builtin privileges. Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/privilege/_builtin" @@ -1437,7 +1437,7 @@ async def get_privileges( """ Get application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -1486,7 +1486,7 @@ async def get_role( the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. - ``_ + ``_ :param name: The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about @@ -1534,7 +1534,7 @@ async def get_role_mapping( rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files. - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -1583,7 +1583,7 @@ async def get_service_accounts( Get service accounts. Get a list of service accounts that match the provided path parameters. - ``_ + ``_ :param namespace: Name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must also omit @@ -1634,7 +1634,7 @@ async def get_service_credentials( """ Get service account credentials. - ``_ + ``_ :param namespace: Name of the namespace. :param service: Name of the service name. @@ -1702,7 +1702,7 @@ async def get_token( """ Get a token. Create a bearer token for access without requiring basic authentication. - ``_ + ``_ :param grant_type: :param kerberos_ticket: @@ -1761,7 +1761,7 @@ async def get_user( """ Get users. Get information about users in the native realm and built-in users. - ``_ + ``_ :param username: An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves @@ -1812,7 +1812,7 @@ async def get_user_privileges( """ Get user privileges. - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -1862,7 +1862,7 @@ async def get_user_profile( """ Get a user profile. Get a user's profile using the unique profile ID. - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: List of filters for the `data` field of the profile document. To @@ -1940,7 +1940,7 @@ async def grant_api_key( API keys never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param api_key: Defines the API key. :param grant_type: The type of grant. Supported grant types are: `access_token`, @@ -2052,6 +2052,7 @@ async def has_privileges( "monitor_ml", "monitor_rollup", "monitor_snapshot", + "monitor_stats", "monitor_text_structure", "monitor_transform", "monitor_watcher", @@ -2081,7 +2082,7 @@ async def has_privileges( Check user privileges. Determine whether the specified user has a specified list of privileges. - ``_ + ``_ :param user: Username :param application: @@ -2141,7 +2142,7 @@ async def has_privileges_user_profile( Check user profile privileges. Determine whether the users associated with the specified user profile IDs have all the requested privileges. - ``_ + ``_ :param privileges: :param uids: A list of profile IDs. The privileges are checked for associated @@ -2210,7 +2211,7 @@ async def invalidate_api_key( by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. - ``_ + ``_ :param id: :param ids: A list of API key ids. This parameter cannot be used with any of @@ -2286,7 +2287,7 @@ async def invalidate_token( 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. - ``_ + ``_ :param realm_name: :param refresh_token: @@ -2346,7 +2347,7 @@ async def put_privileges( """ Create or update application privileges. - ``_ + ``_ :param privileges: :param refresh: If `true` (the default) then refresh the affected shards to make @@ -2392,6 +2393,7 @@ async def put_privileges( "global_", "indices", "metadata", + "remote_cluster", "remote_indices", "run_as", "transient_metadata", @@ -2452,6 +2454,7 @@ async def put_role( "monitor_ml", "monitor_rollup", "monitor_snapshot", + "monitor_stats", "monitor_text_structure", "monitor_transform", "monitor_watcher", @@ -2481,6 +2484,7 @@ async def put_role( refresh: t.Optional[ t.Union[bool, str, t.Literal["false", "true", "wait_for"]] ] = None, + remote_cluster: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None, remote_indices: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None, run_as: t.Optional[t.Sequence[str]] = None, transient_metadata: t.Optional[t.Mapping[str, t.Any]] = None, @@ -2492,7 +2496,7 @@ async def put_role( The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless. - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -2508,6 +2512,7 @@ async def put_role( :param refresh: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + :param remote_cluster: A list of remote cluster permissions entries. :param remote_indices: A list of remote indices permissions entries. :param run_as: A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, @@ -2549,6 +2554,8 @@ async def put_role( __body["indices"] = indices if metadata is not None: __body["metadata"] = metadata + if remote_cluster is not None: + __body["remote_cluster"] = remote_cluster if remote_indices is not None: __body["remote_indices"] = remote_indices if run_as is not None: @@ -2605,7 +2612,7 @@ async def put_role_mapping( roles. Roles can be created by using the create or update roles API or roles files. - ``_ + ``_ :param name: Role-mapping name :param enabled: @@ -2694,7 +2701,7 @@ async def put_user( when updating an existing user. To change a user’s password without updating any other fields, use the change password API. - ``_ + ``_ :param username: The username of the User :param email: @@ -2792,7 +2799,7 @@ async def query_api_keys( Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query. - ``_ + ``_ :param aggregations: Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only @@ -2919,7 +2926,7 @@ async def query_role( Find roles with a query. Get roles in a paginated manner. You can optionally filter the results with a query. - ``_ + ``_ :param from_: Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more @@ -3005,7 +3012,7 @@ async def query_user( Find users with a query. Get information for users in a paginated manner. You can optionally filter the results with a query. - ``_ + ``_ :param from_: Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more @@ -3083,7 +3090,7 @@ async def saml_authenticate( """ Authenticate SAML. Submits a SAML response message to Elasticsearch for consumption. - ``_ + ``_ :param content: The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document. @@ -3145,7 +3152,7 @@ async def saml_complete_logout( """ Logout of SAML completely. Verifies the logout response sent from the SAML IdP. - ``_ + ``_ :param ids: A json array with all the valid SAML Request Ids that the caller of the API has for the current user. @@ -3211,7 +3218,7 @@ async def saml_invalidate( """ Invalidate SAML. Submits a SAML LogoutRequest message to Elasticsearch for consumption. - ``_ + ``_ :param query_string: The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include @@ -3278,7 +3285,7 @@ async def saml_logout( """ Logout of SAML. Submits a request to invalidate an access token and refresh token. - ``_ + ``_ :param token: The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received @@ -3336,7 +3343,7 @@ async def saml_prepare_authentication( Prepare SAML authentication. Creates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. - ``_ + ``_ :param acs: The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication @@ -3392,7 +3399,7 @@ async def saml_service_provider_metadata( Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider. - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -3439,7 +3446,7 @@ async def suggest_user_profiles( Suggest a user profile. Get suggestions for user profiles that match specified search criteria. - ``_ + ``_ :param data: List of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content use `data=` @@ -3523,7 +3530,7 @@ async def update_api_key( not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required. - ``_ + ``_ :param id: The ID of the API key to update. :param expiration: Expiration time for the API key. @@ -3595,7 +3602,7 @@ async def update_cross_cluster_api_key( Update a cross-cluster API key. Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. - ``_ + ``_ :param id: The ID of the cross-cluster API key to update. :param access: The access to be granted to this API key. The access is composed @@ -3667,7 +3674,7 @@ async def update_user_profile_data( Update user profile data. Update specific data for the user profile that is associated with a unique ID. - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: Non-searchable data that you want to associate with the user profile. diff --git a/elasticsearch/_async/client/slm.py b/elasticsearch/_async/client/slm.py index bbf64654b..6a73b1d3b 100644 --- a/elasticsearch/_async/client/slm.py +++ b/elasticsearch/_async/client/slm.py @@ -38,7 +38,7 @@ async def delete_lifecycle( """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove """ @@ -79,7 +79,7 @@ async def execute_lifecycle( Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to be executed """ @@ -118,7 +118,7 @@ async def execute_retention( """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/_execute_retention" @@ -155,7 +155,7 @@ async def get_lifecycle( Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - ``_ + ``_ :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve """ @@ -198,7 +198,7 @@ async def get_stats( Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stats" @@ -233,7 +233,7 @@ async def get_status( """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/status" @@ -279,7 +279,7 @@ async def put_lifecycle( """ Creates or updates a snapshot lifecycle policy. - ``_ + ``_ :param policy_id: ID for the snapshot lifecycle policy you want to create or update. @@ -356,7 +356,7 @@ async def start( """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/start" @@ -391,7 +391,7 @@ async def stop( """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stop" diff --git a/elasticsearch/_async/client/snapshot.py b/elasticsearch/_async/client/snapshot.py index b9dfdc634..d07ce6479 100644 --- a/elasticsearch/_async/client/snapshot.py +++ b/elasticsearch/_async/client/snapshot.py @@ -47,7 +47,7 @@ async def cleanup_repository( Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -101,7 +101,7 @@ async def clone( """ Clones indices from one snapshot into another snapshot in the same repository. - ``_ + ``_ :param repository: A repository name :param snapshot: The name of the snapshot to clone from @@ -184,7 +184,7 @@ async def create( """ Creates a snapshot in a repository. - ``_ + ``_ :param repository: Repository for the snapshot. :param snapshot: Name of the snapshot. Must be unique in the repository. @@ -288,7 +288,7 @@ async def create_repository( """ Creates a repository. - ``_ + ``_ :param name: A repository name :param repository: @@ -348,7 +348,7 @@ async def delete( """ Deletes one or more snapshots. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -399,7 +399,7 @@ async def delete_repository( """ Deletes a repository. - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -473,7 +473,7 @@ async def get( """ Returns information about a snapshot. - ``_ + ``_ :param repository: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. @@ -585,7 +585,7 @@ async def get_repository( """ Returns information about a repository. - ``_ + ``_ :param name: A comma-separated list of repository names :param local: Return local information, do not retrieve the state from master @@ -644,7 +644,7 @@ async def repository_verify_integrity( """ Verifies the integrity of the contents of a snapshot repository - ``_ + ``_ :param name: A repository name :param blob_thread_pool_concurrency: Number of threads to use for reading blob @@ -741,7 +741,7 @@ async def restore( """ Restores a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -834,7 +834,7 @@ async def status( """ Returns information about the status of a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -893,7 +893,7 @@ async def verify_repository( """ Verifies a repository. - ``_ + ``_ :param name: A repository name :param master_timeout: Explicit operation timeout for connection to master node diff --git a/elasticsearch/_async/client/sql.py b/elasticsearch/_async/client/sql.py index c4b2f4335..a18926827 100644 --- a/elasticsearch/_async/client/sql.py +++ b/elasticsearch/_async/client/sql.py @@ -39,9 +39,9 @@ async def clear_cursor( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Clears the SQL cursor + Clear an SQL search cursor. - ``_ + ``_ :param cursor: Cursor to clear. """ @@ -84,10 +84,10 @@ async def delete_async( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes an async SQL search or a stored synchronous SQL search. If the search - is still running, the API cancels it. + Delete an async SQL search. Delete an async SQL search or a stored synchronous + SQL search. If the search is still running, the API cancels it. - ``_ + ``_ :param id: Identifier for the search. """ @@ -131,10 +131,10 @@ async def get_async( ] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status and available results for an async SQL search or stored - synchronous SQL search + Get async SQL search results. Get the current status and available results for + an async SQL search or stored synchronous SQL search. - ``_ + ``_ :param id: Identifier for the search. :param delimiter: Separator for CSV results. The API only supports this parameter @@ -189,10 +189,10 @@ async def get_async_status( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status of an async SQL search or a stored synchronous SQL - search + Get the async SQL search status. Get the current status of an async SQL search + or a stored synchronous SQL search. - ``_ + ``_ :param id: Identifier for the search. """ @@ -273,9 +273,9 @@ async def query( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Executes a SQL request + Get SQL search results. Run an SQL request. - ``_ + ``_ :param catalog: Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. @@ -383,9 +383,10 @@ async def translate( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Translates SQL into Elasticsearch queries + Translate SQL into Elasticsearch queries. Translate an SQL search into a search + API request containing Query DSL. - ``_ + ``_ :param query: SQL query to run. :param fetch_size: The maximum number of rows (or entries) to return in one response. diff --git a/elasticsearch/_async/client/ssl.py b/elasticsearch/_async/client/ssl.py index 75f423927..6ab683691 100644 --- a/elasticsearch/_async/client/ssl.py +++ b/elasticsearch/_async/client/ssl.py @@ -53,7 +53,7 @@ async def certificates( the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ssl/certificates" diff --git a/elasticsearch/_async/client/synonyms.py b/elasticsearch/_async/client/synonyms.py index fac176a30..3ebdd183a 100644 --- a/elasticsearch/_async/client/synonyms.py +++ b/elasticsearch/_async/client/synonyms.py @@ -36,9 +36,9 @@ async def delete_synonym( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a synonym set + Delete a synonym set. - ``_ + ``_ :param id: The id of the synonyms set to be deleted """ @@ -77,9 +77,9 @@ async def delete_synonym_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a synonym rule in a synonym set + Delete a synonym rule. Delete a synonym rule from a synonym set. - ``_ + ``_ :param set_id: The id of the synonym set to be updated :param rule_id: The id of the synonym rule to be deleted @@ -127,9 +127,9 @@ async def get_synonym( size: t.Optional[int] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves a synonym set + Get a synonym set. - ``_ + ``_ :param id: "The id of the synonyms set to be retrieved :param from_: Starting offset for query rules to be retrieved @@ -174,9 +174,9 @@ async def get_synonym_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves a synonym rule from a synonym set + Get a synonym rule. Get a synonym rule from a synonym set. - ``_ + ``_ :param set_id: The id of the synonym set to retrieve the synonym rule from :param rule_id: The id of the synonym rule to retrieve @@ -223,9 +223,9 @@ async def get_synonyms_sets( size: t.Optional[int] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves a summary of all defined synonym sets + Get all synonym sets. Get a summary of all defined synonym sets. - ``_ + ``_ :param from_: Starting offset :param size: specifies a max number of results to get @@ -272,9 +272,11 @@ async def put_synonym( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a synonym set. + Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 + synonym rules per set. If you need to manage more synonym rules, you can create + multiple synonym sets. - ``_ + ``_ :param id: The id of the synonyms set to be created or updated :param synonyms_set: The synonym set information to update @@ -325,9 +327,10 @@ async def put_synonym_rule( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a synonym rule in a synonym set + Create or update a synonym rule. Create or update a synonym rule in a synonym + set. - ``_ + ``_ :param set_id: The id of the synonym set to be updated with the synonym rule :param rule_id: The id of the synonym rule to be updated or created diff --git a/elasticsearch/_async/client/tasks.py b/elasticsearch/_async/client/tasks.py index ffeb14f40..8ec12f8fa 100644 --- a/elasticsearch/_async/client/tasks.py +++ b/elasticsearch/_async/client/tasks.py @@ -49,7 +49,7 @@ async def cancel( """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :param task_id: ID of the task. :param actions: Comma-separated list or wildcard expression of actions used to @@ -110,7 +110,7 @@ async def get( Get task information. Returns information about the tasks currently executing in the cluster. - ``_ + ``_ :param task_id: ID of the task. :param timeout: Period to wait for a response. If no response is received before @@ -169,7 +169,7 @@ async def list( The task management API returns information about tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :param actions: Comma-separated list or wildcard expression of actions used to limit the request. diff --git a/elasticsearch/_async/client/text_structure.py b/elasticsearch/_async/client/text_structure.py index 406592946..db4ae5d73 100644 --- a/elasticsearch/_async/client/text_structure.py +++ b/elasticsearch/_async/client/text_structure.py @@ -53,7 +53,7 @@ async def find_structure( Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. - ``_ + ``_ :param text_files: :param charset: The text’s character set. It must be a character set that is @@ -193,7 +193,7 @@ async def test_grok_pattern( """ Tests a Grok pattern on some text. - ``_ + ``_ :param grok_pattern: Grok pattern to run on the text. :param text: Lines of text to run the Grok pattern on. diff --git a/elasticsearch/_async/client/transform.py b/elasticsearch/_async/client/transform.py index fb12e6a04..1eb51214a 100644 --- a/elasticsearch/_async/client/transform.py +++ b/elasticsearch/_async/client/transform.py @@ -41,7 +41,7 @@ async def delete_transform( """ Delete a transform. Deletes a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param delete_dest_index: If this value is true, the destination index is deleted @@ -101,7 +101,7 @@ async def get_transform( """ Get transforms. Retrieves configuration information for transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -170,7 +170,7 @@ async def get_transform_stats( """ Get transform stats. Retrieves usage information for transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -256,7 +256,7 @@ async def preview_transform( These values are determined based on the field types of the source index and the transform aggregations. - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -393,7 +393,7 @@ async def put_transform( If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -495,7 +495,7 @@ async def reset_transform( it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -547,7 +547,7 @@ async def schedule_now_transform( the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime. - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Controls the time to wait for the scheduling to take place @@ -611,7 +611,7 @@ async def start_transform( privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. - ``_ + ``_ :param transform_id: Identifier for the transform. :param from_: Restricts the set of transformed entities to those changed after @@ -665,7 +665,7 @@ async def stop_transform( """ Stop transforms. Stops one or more transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, @@ -765,7 +765,7 @@ async def update_transform( which roles the user who updated it had at the time of update and runs with those privileges. - ``_ + ``_ :param transform_id: Identifier for the transform. :param defer_validation: When true, deferrable validations are not run. This @@ -852,7 +852,7 @@ async def upgrade_transforms( the role used to read source data and write to the destination index remains unchanged. - ``_ + ``_ :param dry_run: When true, the request checks for updates but does not run them. :param timeout: Period to wait for a response. If no response is received before diff --git a/elasticsearch/_async/client/watcher.py b/elasticsearch/_async/client/watcher.py index 7b63b0cac..e83b8328c 100644 --- a/elasticsearch/_async/client/watcher.py +++ b/elasticsearch/_async/client/watcher.py @@ -39,7 +39,7 @@ async def ack_watch( """ Acknowledges a watch, manually throttling the execution of the watch's actions. - ``_ + ``_ :param watch_id: Watch ID :param action_id: A comma-separated list of the action ids to be acked @@ -90,7 +90,7 @@ async def activate_watch( """ Activates a currently inactive watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -130,7 +130,7 @@ async def deactivate_watch( """ Deactivates a currently active watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -170,7 +170,7 @@ async def delete_watch( """ Removes a watch from Watcher. - ``_ + ``_ :param id: Watch ID """ @@ -245,7 +245,7 @@ async def execute_watch( and control whether a watch record would be written to the watch history after execution. - ``_ + ``_ :param id: Identifier for the watch. :param action_modes: Determines how to handle the watch actions as part of the @@ -328,7 +328,7 @@ async def get_watch( """ Retrieves a watch by its ID. - ``_ + ``_ :param id: Watch ID """ @@ -390,7 +390,7 @@ async def put_watch( """ Creates a new watch, or updates an existing one. - ``_ + ``_ :param id: Watch ID :param actions: @@ -487,7 +487,7 @@ async def query_watches( """ Retrieves stored watches. - ``_ + ``_ :param from_: The offset from the first result to fetch. Needs to be non-negative. :param query: Optional, query filter watches to be returned. @@ -557,7 +557,7 @@ async def start( """ Starts Watcher if it is not already running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_start" @@ -614,7 +614,7 @@ async def stats( """ Retrieves the current Watcher metrics. - ``_ + ``_ :param metric: Defines which additional metrics are included in the response. :param emit_stacktraces: Defines whether stack traces are generated for each @@ -660,7 +660,7 @@ async def stop( """ Stops Watcher if it is running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_stop" diff --git a/elasticsearch/_async/client/xpack.py b/elasticsearch/_async/client/xpack.py index 08ca0f37d..9f3c6a775 100644 --- a/elasticsearch/_async/client/xpack.py +++ b/elasticsearch/_async/client/xpack.py @@ -45,7 +45,7 @@ async def info( """ Provides general information about the installed X-Pack features. - ``_ + ``_ :param accept_enterprise: If this param is used it must be set to true :param categories: A comma-separated list of the information categories to include @@ -90,7 +90,7 @@ async def usage( This API provides information about which features are currently enabled and available under the current license and some usage statistics. - ``_ + ``_ :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 diff --git a/elasticsearch/_sync/client/__init__.py b/elasticsearch/_sync/client/__init__.py index adf877523..48b96a052 100644 --- a/elasticsearch/_sync/client/__init__.py +++ b/elasticsearch/_sync/client/__init__.py @@ -644,7 +644,7 @@ def bulk( in a single API call. This reduces overhead and can greatly increase indexing speed. - ``_ + ``_ :param operations: :param index: Name of the data stream, index, or index alias to perform bulk @@ -744,7 +744,7 @@ def clear_scroll( Clear a scrolling search. Clear the search context and results for a scrolling search. - ``_ + ``_ :param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`. """ @@ -798,7 +798,7 @@ def close_point_in_time( period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. - ``_ + ``_ :param id: The ID of the point-in-time. """ @@ -870,9 +870,9 @@ def count( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns number of documents matching a query. + Count search results. Get the number of documents matching a query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -1007,7 +1007,7 @@ def create( and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template @@ -1111,7 +1111,7 @@ def delete( """ Delete a document. Removes a JSON document from the specified index. - ``_ + ``_ :param index: Name of the target index. :param id: Unique identifier for the document. @@ -1233,7 +1233,7 @@ def delete_by_query( """ Delete documents. Deletes documents that match the specified query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -1414,7 +1414,7 @@ def delete_by_query_rethrottle( 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 @@ -1460,7 +1460,7 @@ def delete_script( """ Delete a script or search template. Deletes a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Period to wait for a connection to the master node. If @@ -1528,7 +1528,7 @@ def exists( """ Check a document. Checks if a specified document exists. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1629,7 +1629,7 @@ def exists_source( """ Check for a document source. Checks if a document's `_source` is stored. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1730,7 +1730,7 @@ def explain( Explain a document match result. Returns information about why a specific document matches, or doesn’t match, a query. - ``_ + ``_ :param index: Index names used to limit the request. Only a single index name can be provided to this parameter. @@ -1853,7 +1853,7 @@ def field_caps( field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -1970,7 +1970,7 @@ def get( Get a document by its ID. Retrieves the document with the specified ID from an index. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2059,7 +2059,7 @@ def get_script( """ Get a script or search template. Retrieves a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Specify timeout for connection to master @@ -2101,7 +2101,7 @@ def get_script_context( """ Get script contexts. Get a list of supported script contexts and their methods. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_context" @@ -2136,7 +2136,7 @@ def get_script_languages( """ Get script languages. Get a list of available script types, languages, and contexts. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_language" @@ -2191,7 +2191,7 @@ def get_source( """ Get a document's source. Returns the source of a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2274,7 +2274,7 @@ def health_report( """ Returns the health of the cluster. - ``_ + ``_ :param feature: A feature of the cluster, as returned by the top-level health report API. @@ -2351,7 +2351,7 @@ def index( and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. :param document: @@ -2460,7 +2460,7 @@ def info( """ Get cluster info. Returns basic information about the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/" @@ -2525,7 +2525,7 @@ def knn_search( The kNN search API supports restricting the search using a filter. The search will return the top k documents that also match the filter query. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or to perform the operation on all indices @@ -2629,7 +2629,7 @@ def mget( IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. - ``_ + ``_ :param index: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. @@ -2756,7 +2756,7 @@ def msearch( Each newline character may be preceded by a carriage return `\\r`. When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`. - ``_ + ``_ :param searches: :param index: Comma-separated list of data streams, indices, and index aliases @@ -2888,7 +2888,7 @@ def msearch_template( """ Run multiple templated searches. - ``_ + ``_ :param search_templates: :param index: Comma-separated list of data streams, indices, and aliases to search. @@ -2987,7 +2987,7 @@ def mtermvectors( with all the fetched termvectors. Each element has the structure provided by the termvectors API. - ``_ + ``_ :param index: Name of the index that contains the documents. :param docs: Array of existing or artificial documents. @@ -3077,6 +3077,7 @@ def open_point_in_time( *, index: t.Union[str, t.Sequence[str]], keep_alive: t.Union[str, t.Literal[-1], t.Literal[0]], + allow_partial_search_results: t.Optional[bool] = None, error_trace: t.Optional[bool] = None, expand_wildcards: t.Optional[ t.Union[ @@ -3106,11 +3107,15 @@ def open_point_in_time( A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. - ``_ + ``_ :param index: A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices :param keep_alive: Extends the time to live of the corresponding point in time. + :param allow_partial_search_results: If `false`, creating a point in time request + when a shard is missing or unavailable will throw an exception. If `true`, + the point in time will contain all the shards that are available at the time + of the request. :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 @@ -3133,6 +3138,8 @@ def open_point_in_time( __body: t.Dict[str, t.Any] = body if body is not None else {} if keep_alive is not None: __query["keep_alive"] = keep_alive + if allow_partial_search_results is not None: + __query["allow_partial_search_results"] = allow_partial_search_results if error_trace is not None: __query["error_trace"] = error_trace if expand_wildcards is not None: @@ -3188,7 +3195,7 @@ def put_script( Create or update a script or search template. Creates or updates a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. Must be unique within the cluster. @@ -3274,7 +3281,7 @@ def rank_eval( Evaluate ranked search results. Evaluate the quality of ranked search results over a set of typical search queries. - ``_ + ``_ :param requests: A set of typical search requests, together with their provided ratings. @@ -3370,7 +3377,7 @@ def reindex( can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. - ``_ + ``_ :param dest: The destination you are copying to. :param source: The source you are copying from. @@ -3467,7 +3474,7 @@ def reindex_rethrottle( Throttle a reindex operation. Change the number of requests per second for a particular reindex operation. - ``_ + ``_ :param task_id: Identifier for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -3518,7 +3525,7 @@ def render_search_template( """ Render a search template. Render a search template as a search request body. - ``_ + ``_ :param id: ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. @@ -3587,7 +3594,7 @@ def scripts_painless_execute( """ Run a script. Runs a script and returns a result. - ``_ + ``_ :param context: The context that the script should run in. :param context_setup: Additional parameters for the `context`. @@ -3660,7 +3667,7 @@ def scroll( of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. - ``_ + ``_ :param scroll_id: Scroll ID of the search. :param rest_total_hits_as_int: If true, the API response’s hit.total property @@ -3852,7 +3859,7 @@ def search( can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -4282,7 +4289,7 @@ def search_mvt( """ Search a vector tile. Search a vector tile for geospatial values. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, or aliases to search :param field: Field containing geospatial data to return @@ -4439,7 +4446,7 @@ def search_shards( optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section. - ``_ + ``_ :param index: Returns the indices and shards that a search request would be executed against. @@ -4540,7 +4547,7 @@ 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 (*). @@ -4680,7 +4687,7 @@ def terms_enum( 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. @@ -4779,7 +4786,7 @@ def termvectors( Get term vector information. Get information and statistics about terms in the fields of a particular document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -4922,7 +4929,7 @@ def update( Update a document. Updates a document by running a script or passing a partial document. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -5088,7 +5095,7 @@ def update_by_query( is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -5287,7 +5294,7 @@ def update_by_query_rethrottle( 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/_sync/client/async_search.py b/elasticsearch/_sync/client/async_search.py index 147553dc3..87a8e5707 100644 --- a/elasticsearch/_sync/client/async_search.py +++ b/elasticsearch/_sync/client/async_search.py @@ -42,7 +42,7 @@ def delete( 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. """ @@ -90,7 +90,7 @@ def get( 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 @@ -145,6 +145,7 @@ def status( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ @@ -153,9 +154,12 @@ def status( 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. + Ongoing async searches and any saved search results are deleted after this + period. """ if id in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'id'") @@ -168,6 +172,8 @@ def status( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if keep_alive is not None: + __query["keep_alive"] = keep_alive if pretty is not None: __query["pretty"] = pretty __headers = {"accept": "application/json"} @@ -258,7 +264,6 @@ def submit( ignore_throttled: t.Optional[bool] = None, ignore_unavailable: t.Optional[bool] = None, indices_boost: t.Optional[t.Sequence[t.Mapping[str, float]]] = None, - keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, keep_on_completion: t.Optional[bool] = None, knn: t.Optional[ t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]] @@ -269,7 +274,6 @@ def submit( min_score: t.Optional[float] = None, pit: t.Optional[t.Mapping[str, t.Any]] = None, post_filter: t.Optional[t.Mapping[str, t.Any]] = None, - pre_filter_shard_size: t.Optional[int] = None, preference: t.Optional[str] = None, pretty: t.Optional[bool] = None, profile: t.Optional[bool] = None, @@ -283,7 +287,6 @@ def submit( routing: t.Optional[str] = None, runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None, script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None, - scroll: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, search_after: t.Optional[ t.Sequence[t.Union[None, bool, float, int, str, t.Any]] ] = None, @@ -333,7 +336,7 @@ def submit( 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 @@ -376,9 +379,6 @@ def submit( :param ignore_unavailable: Whether specified concrete indices should be ignored when unavailable (missing or closed) :param indices_boost: Boosts the _score of documents from specified indices. - :param keep_alive: Specifies how long the async search needs to be available. - Ongoing async searches and any saved search results are deleted after this - period. :param keep_on_completion: If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. :param knn: Defines the approximate kNN search to run. @@ -394,10 +394,6 @@ def submit( :param pit: Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path. :param post_filter: - :param pre_filter_shard_size: The default value cannot be changed, which enforces - the execution of a pre-filter roundtrip to retrieve statistics from each - shard so that the ones that surely don’t hold any document matching the query - get skipped. :param preference: Specify the node or shard the operation should be performed on (default: random) :param profile: @@ -406,13 +402,13 @@ def submit( :param request_cache: Specify if request cache should be used for this request or not, defaults to true :param rescore: - :param rest_total_hits_as_int: + :param rest_total_hits_as_int: Indicates whether hits.total should be rendered + as an integer or an object in the rest search response :param routing: A comma-separated list of specific routing values :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 script_fields: Retrieve a script evaluation (based on different fields) for each hit. - :param scroll: :param search_after: :param search_type: Search operation type :param seq_no_primary_term: If true, returns sequence number and primary term @@ -509,8 +505,6 @@ def submit( __query["ignore_throttled"] = ignore_throttled if ignore_unavailable is not None: __query["ignore_unavailable"] = ignore_unavailable - if keep_alive is not None: - __query["keep_alive"] = keep_alive if keep_on_completion is not None: __query["keep_on_completion"] = keep_on_completion if lenient is not None: @@ -519,8 +513,6 @@ def submit( __query["max_concurrent_shard_requests"] = max_concurrent_shard_requests if min_compatible_shard_node is not None: __query["min_compatible_shard_node"] = min_compatible_shard_node - if pre_filter_shard_size is not None: - __query["pre_filter_shard_size"] = pre_filter_shard_size if preference is not None: __query["preference"] = preference if pretty is not None: @@ -533,8 +525,6 @@ def submit( __query["rest_total_hits_as_int"] = rest_total_hits_as_int if routing is not None: __query["routing"] = routing - if scroll is not None: - __query["scroll"] = scroll if search_type is not None: __query["search_type"] = search_type if source_excludes is not None: diff --git a/elasticsearch/_sync/client/autoscaling.py b/elasticsearch/_sync/client/autoscaling.py index 6dc45d2a5..ab6ec9f21 100644 --- a/elasticsearch/_sync/client/autoscaling.py +++ b/elasticsearch/_sync/client/autoscaling.py @@ -33,16 +33,23 @@ def delete_autoscaling_policy( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, + timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ Delete an 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 + no response is received before the timeout expires, the request fails and + returns an error. + :param timeout: Period to wait for a response. If no response is received before + the timeout expires, the request fails and returns an error. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'name'") @@ -55,8 +62,12 @@ def delete_autoscaling_policy( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty + if timeout is not None: + __query["timeout"] = timeout __headers = {"accept": "application/json"} return self.perform_request( # type: ignore[return-value] "DELETE", @@ -74,6 +85,7 @@ def get_autoscaling_capacity( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ @@ -90,7 +102,11 @@ def get_autoscaling_capacity( capacity was required. This information is provided for diagnosis only. 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 + returns an error. """ __path_parts: t.Dict[str, str] = {} __path = "/_autoscaling/capacity" @@ -101,6 +117,8 @@ def get_autoscaling_capacity( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty __headers = {"accept": "application/json"} @@ -121,6 +139,7 @@ def get_autoscaling_policy( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ @@ -128,9 +147,12 @@ def get_autoscaling_policy( 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 + no response is received before the timeout expires, the request fails and + returns an error. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'name'") @@ -143,6 +165,8 @@ def get_autoscaling_policy( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty __headers = {"accept": "application/json"} @@ -167,17 +191,24 @@ def put_autoscaling_policy( error_trace: t.Optional[bool] = None, filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, human: t.Optional[bool] = None, + master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, pretty: t.Optional[bool] = None, + timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ Create or update an 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: + :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 + returns an error. + :param timeout: Period to wait for a response. If no response is received before + the timeout expires, the request fails and returns an error. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for parameter 'name'") @@ -196,8 +227,12 @@ def put_autoscaling_policy( __query["filter_path"] = filter_path if human is not None: __query["human"] = human + if master_timeout is not None: + __query["master_timeout"] = master_timeout if pretty is not None: __query["pretty"] = pretty + if timeout is not None: + __query["timeout"] = timeout __body = policy if policy is not None else body __headers = {"accept": "application/json", "content-type": "application/json"} return self.perform_request( # type: ignore[return-value] diff --git a/elasticsearch/_sync/client/cat.py b/elasticsearch/_sync/client/cat.py index c3ddf4dc6..184146e51 100644 --- a/elasticsearch/_sync/client/cat.py +++ b/elasticsearch/_sync/client/cat.py @@ -63,7 +63,7 @@ def aliases( 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`. @@ -151,7 +151,7 @@ def allocation( disk space. 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: Comma-separated list of node identifiers or names used to limit the returned information. @@ -238,7 +238,7 @@ def component_templates( for use by applications. For application consumption, use the get component template API. - ``_ + ``_ :param name: The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned. @@ -322,7 +322,7 @@ def count( console. They are not intended for use by applications. For application consumption, use the count API. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -408,7 +408,7 @@ def fielddata( using the command line or Kibana console. 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. @@ -503,7 +503,7 @@ def health( across multiple nodes. 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`. @@ -580,7 +580,7 @@ def help( """ Get CAT help. Returns help for the CAT APIs. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -678,7 +678,7 @@ def indices( using the command line or Kibana console. 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 @@ -780,7 +780,7 @@ def master( 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`. @@ -955,7 +955,7 @@ def ml_data_frame_analytics( For 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 @@ -1129,7 +1129,7 @@ def ml_datafeeds( using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1502,7 +1502,7 @@ def ml_jobs( for use by applications. For 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 @@ -1691,7 +1691,7 @@ def ml_trained_models( console or command line. They are not intended for use by applications. For 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 @@ -1788,7 +1788,7 @@ def nodeattrs( 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`. @@ -1867,7 +1867,7 @@ def nodes( 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 @@ -1952,7 +1952,7 @@ def pending_tasks( 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`. @@ -2026,7 +2026,7 @@ def plugins( 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`. @@ -2110,7 +2110,7 @@ def recovery( 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 @@ -2202,7 +2202,7 @@ def repositories( 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`. @@ -2281,7 +2281,7 @@ def segments( 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 @@ -2370,7 +2370,7 @@ def shards( 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 @@ -2458,7 +2458,7 @@ def snapshots( 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. @@ -2549,7 +2549,7 @@ def tasks( 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 @@ -2639,7 +2639,7 @@ def templates( 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. @@ -2725,7 +2725,7 @@ def thread_pool( 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. @@ -2980,7 +2980,7 @@ def transforms( command line. They are not intended for use by applications. For 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/_sync/client/ccr.py b/elasticsearch/_sync/client/ccr.py index f3b54acbd..dbd1e1373 100644 --- a/elasticsearch/_sync/client/ccr.py +++ b/elasticsearch/_sync/client/ccr.py @@ -38,7 +38,7 @@ def delete_auto_follow_pattern( """ Deletes auto-follow patterns. - ``_ + ``_ :param name: The name of the auto follow pattern. """ @@ -109,7 +109,7 @@ def follow( """ Creates a new follower index configured to follow the referenced leader index. - ``_ + ``_ :param index: The name of the follower index :param leader_index: @@ -201,7 +201,7 @@ def follow_info( Retrieves information about all follower indices, including parameters and status for each follower index - ``_ + ``_ :param index: A comma-separated list of index patterns; use `_all` to perform the operation on all indices @@ -243,7 +243,7 @@ def follow_stats( Retrieves follower stats. return 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 @@ -296,7 +296,7 @@ def forget_follower( """ Removes the follower retention leases from the leader. - ``_ + ``_ :param index: the name of the leader index for which specified follower retention leases should be removed @@ -353,7 +353,7 @@ def get_auto_follow_pattern( Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. - ``_ + ``_ :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. @@ -397,7 +397,7 @@ def pause_auto_follow_pattern( """ Pauses an auto-follow pattern - ``_ + ``_ :param name: The name of the auto follow pattern that should pause discovering new indices to follow. @@ -439,7 +439,7 @@ def pause_follow( Pauses a follower index. The follower index will not fetch any additional operations from the leader index. - ``_ + ``_ :param index: The name of the follower index that should pause following its leader index. @@ -516,7 +516,7 @@ def put_auto_follow_pattern( cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. - ``_ + ``_ :param name: The name of the collection of auto-follow patterns. :param remote_cluster: The remote cluster containing the leader indices to match @@ -640,7 +640,7 @@ def resume_auto_follow_pattern( """ Resumes an auto-follow pattern that has been paused - ``_ + ``_ :param name: The name of the auto follow pattern to resume discovering new indices to follow. @@ -705,7 +705,7 @@ def resume_follow( """ Resumes a follower index that has been paused - ``_ + ``_ :param index: The name of the follow index to resume following. :param max_outstanding_read_requests: @@ -787,7 +787,7 @@ def stats( """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ccr/stats" @@ -824,7 +824,7 @@ def unfollow( Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. - ``_ + ``_ :param index: The name of the follower index that should be turned into a regular index. diff --git a/elasticsearch/_sync/client/cluster.py b/elasticsearch/_sync/client/cluster.py index d7f60e889..135e92cbe 100644 --- a/elasticsearch/_sync/client/cluster.py +++ b/elasticsearch/_sync/client/cluster.py @@ -46,7 +46,7 @@ def allocation_explain( """ Provides explanations for shard allocations in the cluster. - ``_ + ``_ :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. @@ -117,7 +117,7 @@ def delete_component_template( 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. @@ -167,7 +167,7 @@ def delete_voting_config_exclusions( """ Clears cluster voting config exclusions. - ``_ + ``_ :param wait_for_removal: Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions @@ -215,7 +215,7 @@ def exists_component_template( Check component templates. 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. @@ -270,7 +270,7 @@ def get_component_template( """ Get component templates. Retrieves information about component templates. - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -334,7 +334,7 @@ def get_settings( Returns cluster-wide 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 @@ -424,7 +424,7 @@ def health( by the worst shard status. 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 @@ -528,7 +528,7 @@ def info( """ Get cluster 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. @@ -577,7 +577,7 @@ def pending_tasks( 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. @@ -625,7 +625,7 @@ def post_voting_config_exclusions( """ Updates the cluster voting config exclusions by node ids or node names. - ``_ + ``_ :param node_ids: A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify @@ -700,7 +700,7 @@ def put_component_template( You can include comments anywhere in the request body except before the opening curly bracket. - ``_ + ``_ :param name: Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; @@ -789,7 +789,7 @@ def put_settings( """ Updates the cluster settings. - ``_ + ``_ :param flat_settings: Return settings in flat format (default: false) :param master_timeout: Explicit operation timeout for connection to master node @@ -845,7 +845,7 @@ def remote_info( cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_remote/info" @@ -890,7 +890,7 @@ def reroute( """ Allows to manually change the allocation of individual shards in the cluster. - ``_ + ``_ :param commands: Defines the commands to perform. :param dry_run: If true, then the request simulates the operation only and returns @@ -977,7 +977,7 @@ def state( """ Returns a comprehensive information about the state of the cluster. - ``_ + ``_ :param metric: Limit the information returned to the specified metrics :param index: A comma-separated list of index names; use `_all` or empty string @@ -1063,7 +1063,7 @@ def stats( 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/_sync/client/connector.py b/elasticsearch/_sync/client/connector.py index 58d551bb7..313ca16e2 100644 --- a/elasticsearch/_sync/client/connector.py +++ b/elasticsearch/_sync/client/connector.py @@ -46,7 +46,7 @@ def check_in( Check in a connector. 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 """ @@ -91,7 +91,7 @@ def delete( ingest pipelines, or data indices associated with the connector. 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 @@ -136,7 +136,7 @@ def get( """ Get a connector. Get the details about a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector """ @@ -232,7 +232,7 @@ def last_sync( Update the connector last sync stats. Update the fields related to the last sync of a connector. 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: @@ -327,7 +327,7 @@ def list( """ Get all connectors. Get information about all connectors. - ``_ + ``_ :param connector_name: A comma-separated list of connector names to fetch connector documents for @@ -406,7 +406,7 @@ def post( a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure. - ``_ + ``_ :param description: :param index_name: @@ -485,7 +485,7 @@ 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. @@ -558,7 +558,7 @@ def sync_job_cancel( 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 """ @@ -604,7 +604,7 @@ def sync_job_delete( Delete a connector sync job. Remove a connector sync job and its associated data. 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 @@ -648,7 +648,7 @@ def sync_job_get( """ Get a connector sync job. - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job """ @@ -718,7 +718,7 @@ def sync_job_list( Get all connector sync jobs. 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) @@ -781,7 +781,7 @@ def sync_job_post( Create a connector sync job. 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: @@ -834,7 +834,7 @@ def update_active_filtering( Activate the connector draft filter. Activates the valid draft filtering for a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated """ @@ -884,7 +884,7 @@ def update_api_key_id( secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param api_key_id: @@ -940,7 +940,7 @@ def update_configuration( Update the connector configuration. Update the configuration field in the connector document. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param configuration: @@ -997,7 +997,7 @@ def update_error( to error. Otherwise, if the error is reset to null, the connector status is updated to connected. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param error: @@ -1055,7 +1055,7 @@ def update_filtering( is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param advanced_snippet: @@ -1113,7 +1113,7 @@ def update_filtering_validation( Update the connector draft filtering validation. Update the draft filtering validation info for a connector. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param validation: @@ -1167,7 +1167,7 @@ def update_index_name( Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param index_name: @@ -1221,7 +1221,7 @@ def update_name( """ Update the connector name and description. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param description: @@ -1275,7 +1275,7 @@ def update_native( """ Update the connector is_native flag. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param is_native: @@ -1329,7 +1329,7 @@ def update_pipeline( Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param pipeline: @@ -1382,7 +1382,7 @@ def update_scheduling( """ Update the connector scheduling. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param scheduling: @@ -1435,7 +1435,7 @@ def update_service_type( """ Update the connector service type. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param service_type: @@ -1495,7 +1495,7 @@ def update_status( """ Update the connector status. - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param status: diff --git a/elasticsearch/_sync/client/dangling_indices.py b/elasticsearch/_sync/client/dangling_indices.py index d5d869a65..a41daf50c 100644 --- a/elasticsearch/_sync/client/dangling_indices.py +++ b/elasticsearch/_sync/client/dangling_indices.py @@ -44,7 +44,7 @@ def delete_dangling_index( For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. - ``_ + ``_ :param index_uuid: The UUID of the index to delete. Use the get dangling indices API to find the UUID. @@ -103,7 +103,7 @@ def import_dangling_index( For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. - ``_ + ``_ :param index_uuid: The UUID of the index to import. Use the get dangling indices API to locate the UUID. @@ -162,7 +162,7 @@ def list_dangling_indices( indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_dangling" diff --git a/elasticsearch/_sync/client/enrich.py b/elasticsearch/_sync/client/enrich.py index 099cbf2dd..0a8cbe5c1 100644 --- a/elasticsearch/_sync/client/enrich.py +++ b/elasticsearch/_sync/client/enrich.py @@ -38,7 +38,7 @@ def delete_policy( """ Delete an enrich policy. Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :param name: Enrich policy to delete. """ @@ -77,9 +77,9 @@ def execute_policy( wait_for_completion: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates the enrich index for an existing enrich policy. + Run an enrich policy. Create the enrich index for an existing enrich policy. - ``_ + ``_ :param name: Enrich policy to execute. :param wait_for_completion: If `true`, the request blocks other enrich policy @@ -123,7 +123,7 @@ def get_policy( """ Get an enrich policy. Returns information about an enrich policy. - ``_ + ``_ :param name: Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. @@ -173,7 +173,7 @@ def put_policy( """ Create an enrich policy. Creates an enrich policy. - ``_ + ``_ :param name: Name of the enrich policy to create or update. :param geo_match: Matches enrich data to incoming documents based on a `geo_shape` @@ -227,7 +227,7 @@ def stats( Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_enrich/_stats" diff --git a/elasticsearch/_sync/client/eql.py b/elasticsearch/_sync/client/eql.py index 39af43fb0..e59e6dbea 100644 --- a/elasticsearch/_sync/client/eql.py +++ b/elasticsearch/_sync/client/eql.py @@ -36,10 +36,10 @@ def delete( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes an async EQL search or a stored synchronous EQL search. The API also - deletes results for the search. + Delete an async EQL search. Delete an async EQL search or a stored synchronous + EQL search. The API also deletes results for the search. - ``_ + ``_ :param id: Identifier for the search to delete. A search ID is provided in the EQL search API's response for an async search. A search ID is also provided @@ -83,10 +83,10 @@ def get( ] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status and available results for an async EQL search or a - stored synchronous EQL search. + Get async EQL search results. Get the current status and available results for + an async EQL search or a stored synchronous EQL search. - ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -134,10 +134,10 @@ def get_status( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status for an async EQL search or a stored synchronous EQL - search without returning results. + Get the async EQL status. Get the current status for an async EQL search or a + stored synchronous EQL search without returning results. - ``_ + ``_ :param id: Identifier for the search. """ @@ -223,9 +223,11 @@ def search( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns results matching a query expressed in Event Query Language (EQL) + Get EQL search results. Returns search results for an Event Query Language (EQL) + query. EQL assumes each document in a data stream or index corresponds to an + event. - ``_ + ``_ :param index: The name of the index to scope the operation :param query: EQL query you wish to run. diff --git a/elasticsearch/_sync/client/esql.py b/elasticsearch/_sync/client/esql.py index fc9fd2a7e..6d37a7f71 100644 --- a/elasticsearch/_sync/client/esql.py +++ b/elasticsearch/_sync/client/esql.py @@ -68,9 +68,10 @@ def query( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Executes an ES|QL request + Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) + query. - ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. diff --git a/elasticsearch/_sync/client/features.py b/elasticsearch/_sync/client/features.py index 83aa4127e..d60194583 100644 --- a/elasticsearch/_sync/client/features.py +++ b/elasticsearch/_sync/client/features.py @@ -38,7 +38,7 @@ def get_features( Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features" @@ -74,7 +74,7 @@ def reset_features( """ Resets the internal state of features, usually by deleting system indices - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features/_reset" diff --git a/elasticsearch/_sync/client/fleet.py b/elasticsearch/_sync/client/fleet.py index a8a86a7df..39d30f376 100644 --- a/elasticsearch/_sync/client/fleet.py +++ b/elasticsearch/_sync/client/fleet.py @@ -49,7 +49,7 @@ def global_checkpoints( Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. - ``_ + ``_ :param index: A single index or index alias that resolves to a single index. :param checkpoints: A comma separated list of previous global checkpoints. When diff --git a/elasticsearch/_sync/client/graph.py b/elasticsearch/_sync/client/graph.py index 5a29add0b..b8253cfc1 100644 --- a/elasticsearch/_sync/client/graph.py +++ b/elasticsearch/_sync/client/graph.py @@ -45,10 +45,16 @@ def explore( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Extracts and summarizes information about the documents and terms in an Elasticsearch - data stream or index. + Explore graph analytics. Extract and summarize information about the documents + and terms in an Elasticsearch data stream or index. The easiest way to understand + the behavior of this API is to use the Graph UI to explore connections. An initial + request to the `_explore` API contains a seed query that identifies the documents + of interest and specifies the fields that define the vertices and connections + you want to include in the graph. Subsequent requests enable you to spider out + from one more vertices of interest. You can exclude vertices that have already + been returned. - ``_ + ``_ :param index: Name of the index. :param connections: Specifies or more fields from which you want to extract terms diff --git a/elasticsearch/_sync/client/ilm.py b/elasticsearch/_sync/client/ilm.py index 4f8196869..8c98bb4e5 100644 --- a/elasticsearch/_sync/client/ilm.py +++ b/elasticsearch/_sync/client/ilm.py @@ -42,7 +42,7 @@ def delete_lifecycle( that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -97,7 +97,7 @@ def explain_lifecycle( currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -159,7 +159,7 @@ def get_lifecycle( """ Retrieves a lifecycle policy. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -210,7 +210,7 @@ def get_status( """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ilm/status" @@ -254,7 +254,7 @@ def migrate_to_data_tiers( data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers. - ``_ + ``_ :param dry_run: If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides @@ -314,7 +314,7 @@ def move_to_step( """ Manually moves an index into the specified step and executes that step. - ``_ + ``_ :param index: The name of the index whose lifecycle step is to change :param current_step: @@ -378,7 +378,7 @@ def put_lifecycle( Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -437,7 +437,7 @@ def remove_policy( """ Removes the assigned lifecycle policy and stops managing the specified index - ``_ + ``_ :param index: The name of the index to remove policy on """ @@ -477,7 +477,7 @@ def retry( """ Retries executing the policy for an index that is in the ERROR step. - ``_ + ``_ :param index: The name of the indices (comma-separated) whose failed lifecycle step is to be retry @@ -519,7 +519,7 @@ def start( """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ :param master_timeout: :param timeout: @@ -564,7 +564,7 @@ def stop( Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin - ``_ + ``_ :param master_timeout: :param timeout: diff --git a/elasticsearch/_sync/client/indices.py b/elasticsearch/_sync/client/indices.py index 92133311a..4b9988368 100644 --- a/elasticsearch/_sync/client/indices.py +++ b/elasticsearch/_sync/client/indices.py @@ -58,7 +58,7 @@ def add_block( Add an index block. Limits the operations allowed on an index by blocking specific operation types. - ``_ + ``_ :param index: A comma separated list of indices to add a block to :param block: The block to add (one of read, write, read_only or metadata) @@ -146,7 +146,7 @@ def analyze( Get tokens from text analysis. The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens. - ``_ + ``_ :param index: Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the @@ -248,7 +248,7 @@ def clear_cache( Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -333,7 +333,7 @@ def clone( """ Clones an existing index. - ``_ + ``_ :param index: Name of the source index to clone. :param target: Name of the target index to create. @@ -421,7 +421,7 @@ def close( """ Closes an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -502,7 +502,7 @@ def create( """ Create an index. Creates a new index. - ``_ + ``_ :param index: Name of the index you wish to create. :param aliases: Aliases for the index. @@ -576,7 +576,7 @@ def create_data_stream( Create a data stream. Creates a data stream. You must have a matching index template with data stream enabled. - ``_ + ``_ :param name: Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, @@ -637,7 +637,7 @@ def data_streams_stats( """ Get data stream stats. Retrieves statistics for one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a @@ -698,7 +698,7 @@ def delete( """ Delete indices. Deletes one or more indices. - ``_ + ``_ :param index: Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. @@ -768,7 +768,7 @@ def delete_alias( """ Delete an alias. Removes a data stream or index from an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). @@ -833,7 +833,7 @@ def delete_data_lifecycle( Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. - ``_ + ``_ :param name: A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams @@ -893,7 +893,7 @@ def delete_data_stream( """ Delete data streams. Deletes one or more data streams and their backing indices. - ``_ + ``_ :param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. @@ -948,7 +948,7 @@ def delete_index_template( then there is no wildcard support and the provided names should match completely with existing templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1000,7 +1000,7 @@ def delete_template( """ Deletes a legacy index template. - ``_ + ``_ :param name: The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. @@ -1063,7 +1063,7 @@ def disk_usage( """ Analyzes the disk usage of each field of an index or data stream. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single @@ -1139,7 +1139,7 @@ def downsample( (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. - ``_ + ``_ :param index: Name of the time series index to downsample. :param target_index: Name of the index to create. @@ -1208,7 +1208,7 @@ def exists( Check indices. Checks if one or more indices, index aliases, or data streams exist. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1286,7 +1286,7 @@ def exists_alias( """ Check aliases. Checks if one or more data stream or index aliases exist. - ``_ + ``_ :param name: Comma-separated list of aliases to check. Supports wildcards (`*`). :param index: Comma-separated list of data streams or indices used to limit the @@ -1354,9 +1354,9 @@ def exists_index_template( pretty: t.Optional[bool] = None, ) -> HeadApiResponse: """ - Returns information about whether a particular index template exists. + Check index templates. Check whether index templates exist. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1406,7 +1406,7 @@ def exists_template( Check existence of index templates. Returns information about whether a particular index template exists. - ``_ + ``_ :param name: The comma separated names of the index templates :param flat_settings: Return settings in flat format (default: false) @@ -1461,7 +1461,7 @@ def explain_data_lifecycle( creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. - ``_ + ``_ :param index: The name of the index to explain :param include_defaults: indicates if the API should return the default values @@ -1525,7 +1525,7 @@ def field_usage_stats( """ Returns field usage information for each shard and field of an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1613,7 +1613,7 @@ def flush( """ Flushes one or more data streams or indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this @@ -1696,7 +1696,7 @@ def forcemerge( """ Performs the force merge operation on one or more indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1790,7 +1790,7 @@ def get( Get index information. Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -1879,7 +1879,7 @@ def get_alias( """ Get aliases. Retrieves information for one or more data stream or index aliases. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, @@ -1962,7 +1962,7 @@ def get_data_lifecycle( Get data stream lifecycles. Retrieves the data stream lifecycle configuration of one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` @@ -2028,7 +2028,7 @@ def get_data_stream( """ Get data streams. Retrieves information about one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are @@ -2104,7 +2104,7 @@ def get_field_mapping( Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. - ``_ + ``_ :param fields: Comma-separated list or wildcard expression of fields used to limit returned information. @@ -2181,7 +2181,7 @@ def get_index_template( """ Get index templates. Returns information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2255,7 +2255,7 @@ def get_mapping( Get mapping definitions. Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2340,7 +2340,7 @@ def get_settings( Get index settings. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2427,7 +2427,7 @@ def get_template( """ Get index templates. Retrieves information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, @@ -2493,7 +2493,7 @@ def migrate_to_data_stream( with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream. - ``_ + ``_ :param name: Name of the index alias to convert to a data stream. :param master_timeout: Period to wait for a connection to the master node. If @@ -2546,7 +2546,7 @@ def modify_data_stream( Update data streams. Performs one or more data stream modification actions in a single atomic operation. - ``_ + ``_ :param actions: Actions to perform. """ @@ -2606,7 +2606,7 @@ def open( """ Opens a closed index. For data streams, the API opens any closed backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly @@ -2682,7 +2682,7 @@ def promote_data_stream( Promotes a data stream from a replicated data stream managed by CCR to a regular data stream - ``_ + ``_ :param name: The name of the data stream :param master_timeout: Period to wait for a connection to the master node. If @@ -2744,7 +2744,7 @@ def put_alias( """ Create or update an alias. Adds a data stream or index to an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices @@ -2847,7 +2847,7 @@ def put_data_lifecycle( Update data stream lifecycles. Update the data stream lifecycle of the specified data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`. @@ -2949,7 +2949,7 @@ def put_index_template( Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: Index or template name :param allow_auto_create: This setting overrides the value of the `action.auto_create_index` @@ -3110,7 +3110,7 @@ def put_mapping( can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default. - ``_ + ``_ :param index: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. @@ -3240,7 +3240,7 @@ def put_settings( Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. - ``_ + ``_ :param settings: :param index: Comma-separated list of data streams, indices, and aliases used @@ -3345,7 +3345,7 @@ def put_template( Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -3427,7 +3427,7 @@ def recovery( indices. For data streams, the API returns information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3491,7 +3491,7 @@ def refresh( indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3561,7 +3561,7 @@ def reload_search_analyzers( """ Reloads an index's search analyzers and their resources. - ``_ + ``_ :param index: A comma-separated list of index names to reload analyzers for :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -3627,7 +3627,7 @@ def resolve_cluster( including the local cluster, if included. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3698,10 +3698,10 @@ def resolve_index( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Resolves the specified name(s) and/or index patterns for indices, aliases, and - data streams. Multiple patterns and remote clusters are supported. + Resolve indices. Resolve the names and/or index patterns for indices, aliases, + and data streams. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3774,7 +3774,7 @@ def rollover( """ Roll over to a new index. Creates a new index for a data stream or index alias. - ``_ + ``_ :param alias: Name of the data stream or index alias to roll over. :param new_index: Name of the index to create. Supports date math. Data streams @@ -3880,7 +3880,7 @@ def segments( Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3960,7 +3960,7 @@ def shard_stores( Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices. - ``_ + ``_ :param index: List of data streams, indices, and aliases used to limit the request. :param allow_no_indices: If false, the request returns an error if any wildcard @@ -4031,7 +4031,7 @@ def shrink( """ Shrinks an existing index into a new index with fewer primary shards. - ``_ + ``_ :param index: Name of the source index to shrink. :param target: Name of the target index to create. @@ -4107,7 +4107,7 @@ def simulate_index_template( Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template. - ``_ + ``_ :param name: Name of the index to simulate :param include_defaults: If true, returns all relevant default configurations @@ -4185,7 +4185,7 @@ def simulate_template( Simulate an index template. Returns the index configuration that would be applied by a particular index template. - ``_ + ``_ :param name: Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template @@ -4316,7 +4316,7 @@ def split( """ Splits an existing index into a new index with more primary shards. - ``_ + ``_ :param index: Name of the source index to split. :param target: Name of the target index to create. @@ -4409,7 +4409,7 @@ def stats( Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -4512,7 +4512,7 @@ def unfreeze( """ Unfreezes an index. - ``_ + ``_ :param index: Identifier for the index. :param allow_no_indices: If `false`, the request returns an error if any wildcard @@ -4586,7 +4586,7 @@ def update_aliases( """ Create or update an alias. Adds a data stream or index to an alias. - ``_ + ``_ :param actions: Actions to perform. :param master_timeout: Period to wait for a connection to the master node. If @@ -4661,7 +4661,7 @@ def validate_query( """ Validate a query. Validates a query without running it. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this diff --git a/elasticsearch/_sync/client/inference.py b/elasticsearch/_sync/client/inference.py index 9f58dfbfc..051977c8d 100644 --- a/elasticsearch/_sync/client/inference.py +++ b/elasticsearch/_sync/client/inference.py @@ -20,19 +20,12 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import ( - SKIP_IN_PATH, - Stability, - _quote, - _rewrite_parameters, - _stability_warning, -) +from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters class InferenceClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) def delete( self, *, @@ -53,7 +46,7 @@ def delete( """ Delete an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param task_type: The task type @@ -100,7 +93,6 @@ def delete( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) def get( self, *, @@ -119,7 +111,7 @@ def get( """ Get an inference endpoint - ``_ + ``_ :param task_type: The task type :param inference_id: The inference Id @@ -159,7 +151,6 @@ def get( @_rewrite_parameters( body_fields=("input", "query", "task_settings"), ) - @_stability_warning(Stability.EXPERIMENTAL) def inference( self, *, @@ -183,7 +174,7 @@ def inference( """ Perform inference on the service - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -246,7 +237,6 @@ def inference( @_rewrite_parameters( body_name="inference_config", ) - @_stability_warning(Stability.EXPERIMENTAL) def put( self, *, @@ -267,7 +257,7 @@ def put( """ Create an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param inference_config: diff --git a/elasticsearch/_sync/client/ingest.py b/elasticsearch/_sync/client/ingest.py index e244e91a3..49032c8f1 100644 --- a/elasticsearch/_sync/client/ingest.py +++ b/elasticsearch/_sync/client/ingest.py @@ -38,9 +38,10 @@ def delete_geoip_database( timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a geoip database configuration. + Delete GeoIP database configurations. Delete one or more IP geolocation database + configurations. - ``_ + ``_ :param id: A comma-separated list of geoip database configurations to delete :param master_timeout: Period to wait for a connection to the master node. If @@ -89,9 +90,9 @@ def delete_pipeline( timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes one or more existing ingest pipeline. + Delete pipelines. Delete one or more ingest pipelines. - ``_ + ``_ :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. @@ -138,9 +139,10 @@ def geo_ip_stats( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Gets download statistics for GeoIP2 databases used with the geoip processor. + Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used + with the GeoIP processor. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/geoip/stats" @@ -175,9 +177,10 @@ def get_geoip_database( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more geoip database configurations. + Get GeoIP database configurations. Get information about one or more IP geolocation + database configurations. - ``_ + ``_ :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit @@ -227,10 +230,10 @@ def get_pipeline( summary: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more ingest pipelines. This API returns a local - reference of the pipeline. + Get pipelines. Get information about one or more ingest pipelines. This API returns + a local reference of the pipeline. - ``_ + ``_ :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. @@ -279,12 +282,12 @@ def processor_grok( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Extracts structured fields out of a single text field within a document. You - choose which field to extract matched fields from, as well as the grok pattern - you expect will match. A grok pattern is like a regular expression that supports - aliased expressions that can be reused. + Run a grok processor. Extract structured fields out of a single text field within + a document. You must choose which field to extract matched fields from, as well + as the grok pattern you expect will match. A grok pattern is like a regular expression + that supports aliased expressions that can be reused. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/processor/grok" @@ -325,9 +328,10 @@ def put_geoip_database( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more geoip database configurations. + Create or update GeoIP database configurations. Create or update IP geolocation + database configurations. - ``_ + ``_ :param id: ID of the database configuration to create or update. :param maxmind: The configuration necessary to identify which IP geolocation @@ -411,10 +415,9 @@ def put_pipeline( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates an ingest pipeline. Changes made using this API take effect - immediately. + Create or update a pipeline. Changes made using this API take effect immediately. - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param deprecated: Marks this ingest pipeline as deprecated. When a deprecated @@ -504,9 +507,11 @@ def simulate( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Executes an ingest pipeline against a set of provided documents. + Simulate a pipeline. Run an ingest pipeline against a set of provided documents. + You can either specify an existing pipeline to use with the provided documents + or supply a pipeline definition in the body of the request. - ``_ + ``_ :param docs: Sample documents to test in the pipeline. :param id: Pipeline to test. If you don’t specify a `pipeline` in the request diff --git a/elasticsearch/_sync/client/license.py b/elasticsearch/_sync/client/license.py index 28c51de20..dc64acd9e 100644 --- a/elasticsearch/_sync/client/license.py +++ b/elasticsearch/_sync/client/license.py @@ -37,7 +37,7 @@ def delete( """ Deletes licensing information for the cluster - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license" @@ -76,7 +76,7 @@ def get( its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -122,7 +122,7 @@ def get_basic_status( """ Retrieves information about the status of the basic license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/basic_status" @@ -157,7 +157,7 @@ def get_trial_status( """ Retrieves information about the status of the trial license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/trial_status" @@ -198,7 +198,7 @@ def post( """ Updates the license for the cluster. - ``_ + ``_ :param acknowledge: Specifies whether you acknowledge the license changes. :param license: @@ -257,7 +257,7 @@ def post_start_basic( acknowledge parameter set to true. To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -300,7 +300,7 @@ def post_start_trial( The start trial API enables you to start a 30-day trial, which gives access to all subscription features. - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/_sync/client/logstash.py b/elasticsearch/_sync/client/logstash.py index bba034538..f36492625 100644 --- a/elasticsearch/_sync/client/logstash.py +++ b/elasticsearch/_sync/client/logstash.py @@ -38,7 +38,7 @@ def delete_pipeline( """ Deletes a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. """ @@ -78,7 +78,7 @@ def get_pipeline( """ Retrieves pipelines used for Logstash Central Management. - ``_ + ``_ :param id: Comma-separated list of pipeline identifiers. """ @@ -125,7 +125,7 @@ def put_pipeline( """ Creates or updates a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. :param pipeline: diff --git a/elasticsearch/_sync/client/migration.py b/elasticsearch/_sync/client/migration.py index bb6f718d6..6c81b32cd 100644 --- a/elasticsearch/_sync/client/migration.py +++ b/elasticsearch/_sync/client/migration.py @@ -40,7 +40,7 @@ def deprecations( that use deprecated features that will be removed or changed in the next major version. - ``_ + ``_ :param index: Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. @@ -83,7 +83,7 @@ def get_feature_upgrade_status( """ Find out whether system features need to be upgraded or not - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" @@ -118,7 +118,7 @@ def post_feature_upgrade( """ Begin upgrades for system features - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" diff --git a/elasticsearch/_sync/client/ml.py b/elasticsearch/_sync/client/ml.py index ebf72ef18..2146426ec 100644 --- a/elasticsearch/_sync/client/ml.py +++ b/elasticsearch/_sync/client/ml.py @@ -42,7 +42,7 @@ def clear_trained_model_deployment_cache( may be cached on that individual node. Calling this API clears the caches without restarting the deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -102,7 +102,7 @@ def close_job( force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection @@ -164,7 +164,7 @@ def delete_calendar( Delete a calendar. Removes all scheduled events from a calendar, then deletes it. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -205,7 +205,7 @@ def delete_calendar_event( """ Delete events from a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param event_id: Identifier for the scheduled event. You can obtain this identifier @@ -253,7 +253,7 @@ def delete_calendar_job( """ Delete anomaly jobs from a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -302,7 +302,7 @@ def delete_data_frame_analytics( """ Delete a data frame analytics job. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param force: If `true`, it deletes a job that is not stopped; this method is @@ -350,7 +350,7 @@ def delete_datafeed( """ Delete a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -408,7 +408,7 @@ def delete_expired_data( expired data for all anomaly detection jobs by using _all, by specifying * as the , or by omitting the . - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -469,7 +469,7 @@ def delete_filter( delete the filter. You must update or delete the job before you can delete the filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -515,7 +515,7 @@ def delete_forecast( in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -587,7 +587,7 @@ def delete_job( delete datafeed API with the same timeout and force parameters as the delete job request. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param delete_user_annotations: Specifies whether annotations that have been @@ -643,7 +643,7 @@ def delete_model_snapshot( that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -691,7 +691,7 @@ def delete_trained_model( Delete an unreferenced trained model. The request deletes a trained inference model that is not referenced by an ingest pipeline. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param force: Forcefully deletes a trained model that is referenced by ingest @@ -738,7 +738,7 @@ def delete_trained_model_alias( to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -795,7 +795,7 @@ def estimate_model_memory( an anomaly detection job model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references. - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -863,7 +863,7 @@ def evaluate_data_frame( for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -943,7 +943,7 @@ def explain_data_frame_analytics( setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -1050,7 +1050,7 @@ def flush_job( and persists the model state to disk and the job must be opened again before analyzing further data. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -1121,7 +1121,7 @@ def forecast( for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -1204,7 +1204,7 @@ def get_buckets( Get anomaly detection job results for buckets. The API presents a chronological view of the records, grouped by bucket. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1299,7 +1299,7 @@ def get_calendar_events( """ Get info about events in calendars. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1365,7 +1365,7 @@ def get_calendars( """ Get calendar configuration info. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1438,7 +1438,7 @@ def get_categories( """ Get anomaly detection job results for categories. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param category_id: Identifier for the category, which is unique in the job. @@ -1522,7 +1522,7 @@ def get_data_frame_analytics( multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1594,7 +1594,7 @@ def get_data_frame_analytics_stats( """ Get data frame analytics jobs usage info. - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1664,7 +1664,7 @@ def get_datafeed_stats( the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1724,7 +1724,7 @@ def get_datafeeds( `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1787,7 +1787,7 @@ def get_filters( """ Get filters. You can get a single filter or all filters. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1851,7 +1851,7 @@ def get_influencers( that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -1932,7 +1932,7 @@ def get_job_stats( """ Get anomaly detection jobs usage info. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. If @@ -1993,7 +1993,7 @@ def get_jobs( detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these @@ -2056,7 +2056,7 @@ def get_memory_stats( jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -2111,7 +2111,7 @@ def get_model_snapshot_upgrade_stats( """ Get anomaly detection job model snapshot upgrade usage info. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2182,7 +2182,7 @@ def get_model_snapshots( """ Get model snapshots info. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2295,7 +2295,7 @@ def get_overall_buckets( its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. @@ -2400,7 +2400,7 @@ def get_records( found in each bucket, which relates to the number of time series being modeled and the number of detectors. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2495,7 +2495,7 @@ def get_trained_models( """ Get trained model configuration info. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request @@ -2579,7 +2579,7 @@ def get_trained_models_stats( models in a single API request by using a comma-separated list of model IDs or a wildcard expression. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. @@ -2642,7 +2642,7 @@ def infer_trained_model( """ Evaluate a trained model. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param docs: An array of objects to pass to the model for inference. The objects @@ -2704,7 +2704,7 @@ def info( what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ml/info" @@ -2749,7 +2749,7 @@ def open_job( job is ready to resume its analysis from where it left off, once new data is received. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2803,7 +2803,7 @@ def post_calendar_events( """ Add scheduled events to the calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param events: A list of one of more scheduled events. The event’s start and @@ -2861,7 +2861,7 @@ def post_data( data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -2925,7 +2925,7 @@ def preview_data_frame_analytics( Preview features used by data frame analytics. Previews the extracted features used by a data frame analytics config. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param config: A data frame analytics config as described in create data frame @@ -2995,7 +2995,7 @@ def preview_datafeed( that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3071,7 +3071,7 @@ def put_calendar( """ Create a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -3125,7 +3125,7 @@ def put_calendar_job( """ Add anomaly detection job to calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -3199,7 +3199,7 @@ def put_data_frame_analytics( that performs an analysis on the source indices and stores the outcome in a destination index. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3377,7 +3377,7 @@ def put_datafeed( directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3532,7 +3532,7 @@ def put_filter( more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3619,7 +3619,7 @@ def put_job( Create an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index. - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -3800,7 +3800,7 @@ def put_trained_model( Create a trained model. Enable you to supply a trained model that is not created by data frame analytics. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param compressed_definition: The compressed (GZipped and Base64 encoded) inference @@ -3914,7 +3914,7 @@ def put_trained_model_alias( common between the old and new trained models for the model alias, the API returns a warning. - ``_ + ``_ :param model_id: The identifier for the trained model that the alias refers to. :param model_alias: The alias to create or update. This value cannot end in numbers. @@ -3972,7 +3972,7 @@ def put_trained_model_definition_part( """ Create part of a trained model definition. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param part: The definition part number. When the definition is loaded for inference @@ -4051,7 +4051,7 @@ def put_trained_model_vocabulary( processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -4109,7 +4109,7 @@ def reset_job( job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. - ``_ + ``_ :param job_id: The ID of the job to reset. :param delete_user_annotations: Specifies whether annotations that have been @@ -4169,7 +4169,7 @@ def revert_model_snapshot( For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -4239,7 +4239,7 @@ def set_upgrade_mode( the current value for the upgrade_mode setting by using the get machine learning info API. - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -4294,7 +4294,7 @@ def start_data_frame_analytics( exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4356,7 +4356,7 @@ def start_datafeed( headers when you created or updated the datafeed, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4426,7 +4426,7 @@ def start_trained_model_deployment( Start a trained model deployment. It allocates the model to every machine learning node. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -4510,7 +4510,7 @@ def stop_data_frame_analytics( Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4576,7 +4576,7 @@ def stop_datafeed( Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a @@ -4638,7 +4638,7 @@ def stop_trained_model_deployment( """ Stop a trained model deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -4703,7 +4703,7 @@ def update_data_frame_analytics( """ Update a data frame analytics job. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4815,7 +4815,7 @@ def update_datafeed( query using those same roles. If you provide secondary authorization headers, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4979,7 +4979,7 @@ def update_filter( Update a filter. Updates the description of a filter, adds items, or removes items from the list. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -5070,7 +5070,7 @@ def update_job( Update an anomaly detection job. Updates certain properties of an anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the job. :param allow_lazy_open: Advanced configuration option. Specifies whether this @@ -5198,7 +5198,7 @@ def update_model_snapshot( """ Update a snapshot. Updates certain properties of a snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -5259,7 +5259,7 @@ def update_trained_model_deployment( """ Update a trained model deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -5325,7 +5325,7 @@ def upgrade_job_snapshot( a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -5401,7 +5401,7 @@ def validate( """ Validates an anomaly detection job. - ``_ + ``_ :param analysis_config: :param analysis_limits: @@ -5471,7 +5471,7 @@ def validate_detector( """ Validates an anomaly detection detector. - ``_ + ``_ :param detector: """ diff --git a/elasticsearch/_sync/client/monitoring.py b/elasticsearch/_sync/client/monitoring.py index 0a97e0202..c9a91934e 100644 --- a/elasticsearch/_sync/client/monitoring.py +++ b/elasticsearch/_sync/client/monitoring.py @@ -44,7 +44,7 @@ def bulk( """ Used by the monitoring features to send monitoring data. - ``_ + ``_ :param interval: Collection interval (e.g., '10s' or '10000ms') of the payload :param operations: diff --git a/elasticsearch/_sync/client/nodes.py b/elasticsearch/_sync/client/nodes.py index 5c8e36979..3a4b4a6c5 100644 --- a/elasticsearch/_sync/client/nodes.py +++ b/elasticsearch/_sync/client/nodes.py @@ -47,7 +47,7 @@ def clear_repositories_metering_archive( You can use this API to clear the archived repositories metering information in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -100,7 +100,7 @@ def get_repositories_metering_info( compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it won’t be present after node restarts. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -154,7 +154,7 @@ def hot_threads( This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node’s top hot threads. - ``_ + ``_ :param node_id: List of node IDs or names used to limit returned information. :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket @@ -229,7 +229,7 @@ def info( """ Returns cluster nodes information. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -298,7 +298,7 @@ def reload_secure_settings( """ Reloads the keystore on nodes in the cluster. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. :param secure_settings_password: The password for the Elasticsearch keystore. @@ -369,7 +369,7 @@ def stats( """ Returns cluster nodes statistics. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -486,7 +486,7 @@ def usage( """ Returns information on the usage of features. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting diff --git a/elasticsearch/_sync/client/query_rules.py b/elasticsearch/_sync/client/query_rules.py index d5aaa2f76..0fa60244c 100644 --- a/elasticsearch/_sync/client/query_rules.py +++ b/elasticsearch/_sync/client/query_rules.py @@ -37,9 +37,9 @@ def delete_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a query rule within a query ruleset. + Delete a query rule. Delete a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to delete @@ -85,9 +85,9 @@ def delete_ruleset( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a query ruleset. + Delete a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to delete """ @@ -126,9 +126,9 @@ def get_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the details about a query rule within a query ruleset + Get a query rule. Get details about a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to retrieve @@ -174,9 +174,9 @@ def get_ruleset( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the details about a query ruleset + Get a query ruleset. Get details about a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset """ @@ -217,9 +217,9 @@ def list_rulesets( size: t.Optional[int] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns summarized information about existing query rulesets. + Get all query rulesets. Get summarized information about the query rulesets. - ``_ + ``_ :param from_: Starting offset (default: 0) :param size: specifies a max number of results to get @@ -270,9 +270,9 @@ def put_rule( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a query rule within a query ruleset. + Create or update a query rule. Create or update a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to be created or updated @@ -345,9 +345,9 @@ def put_ruleset( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a query ruleset. + Create or update a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated @@ -398,9 +398,10 @@ def test( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a query ruleset. + Test a query ruleset. Evaluate match criteria against a query ruleset to identify + the rules that would match that criteria. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated diff --git a/elasticsearch/_sync/client/rollup.py b/elasticsearch/_sync/client/rollup.py index 75d86e361..3916fe05d 100644 --- a/elasticsearch/_sync/client/rollup.py +++ b/elasticsearch/_sync/client/rollup.py @@ -45,7 +45,7 @@ def delete_job( """ Deletes an existing rollup job. - ``_ + ``_ :param id: Identifier for the job. """ @@ -86,7 +86,7 @@ def get_jobs( """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :param id: Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. @@ -132,7 +132,7 @@ def get_rollup_caps( Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - ``_ + ``_ :param id: Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. @@ -178,7 +178,7 @@ def get_rollup_index_caps( Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). - ``_ + ``_ :param index: Data stream or index to check for rollup capabilities. Wildcard (`*`) expressions are supported. @@ -241,7 +241,7 @@ def put_job( """ Creates a rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the data that is associated with the rollup job. @@ -358,7 +358,7 @@ def rollup_search( """ Enables searching rolled-up data using the standard Query DSL. - ``_ + ``_ :param index: Enables searching rolled-up data using the standard Query DSL. :param aggregations: Specifies aggregations. @@ -422,7 +422,7 @@ def start_job( """ Starts an existing, stopped rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. """ @@ -465,7 +465,7 @@ def stop_job( """ Stops an existing, started rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum) diff --git a/elasticsearch/_sync/client/search_application.py b/elasticsearch/_sync/client/search_application.py index 42b042434..72dd67ba3 100644 --- a/elasticsearch/_sync/client/search_application.py +++ b/elasticsearch/_sync/client/search_application.py @@ -46,7 +46,7 @@ def delete( Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed. - ``_ + ``_ :param name: The name of the search application to delete """ @@ -88,7 +88,7 @@ def delete_behavioral_analytics( Delete a behavioral analytics collection. The associated data stream is also deleted. - ``_ + ``_ :param name: The name of the analytics collection to be deleted """ @@ -129,7 +129,7 @@ def get( """ Get search application details. - ``_ + ``_ :param name: The name of the search application """ @@ -170,7 +170,7 @@ def get_behavioral_analytics( """ Get behavioral analytics collections. - ``_ + ``_ :param name: A list of analytics collections to limit the returned information """ @@ -218,7 +218,7 @@ def list( """ Returns the existing search applications. - ``_ + ``_ :param from_: Starting offset. :param q: Query in the Lucene query string syntax. @@ -270,7 +270,7 @@ def put( """ Create or update a search application. - ``_ + ``_ :param name: The name of the search application to be created or updated. :param search_application: @@ -324,7 +324,7 @@ def put_behavioral_analytics( """ Create a behavioral analytics collection. - ``_ + ``_ :param name: The name of the analytics collection to be created or updated. """ @@ -374,7 +374,7 @@ def search( the search application or default template. Unspecified template parameters are assigned their default values if applicable. - ``_ + ``_ :param name: The name of the search application to be searched. :param params: Query parameters specific to this request, which will override diff --git a/elasticsearch/_sync/client/searchable_snapshots.py b/elasticsearch/_sync/client/searchable_snapshots.py index 45104eefc..4c316b546 100644 --- a/elasticsearch/_sync/client/searchable_snapshots.py +++ b/elasticsearch/_sync/client/searchable_snapshots.py @@ -46,7 +46,7 @@ def cache_stats( """ Retrieve node-level cache statistics about searchable snapshots. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting @@ -105,7 +105,7 @@ def clear_cache( """ Clear the cache of searchable snapshots. - ``_ + ``_ :param index: A comma-separated list of index names :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -177,7 +177,7 @@ def mount( """ Mount a snapshot as a searchable index. - ``_ + ``_ :param repository: The name of the repository containing the snapshot of the index to mount @@ -257,7 +257,7 @@ def stats( """ Retrieve shard-level statistics about searchable snapshots. - ``_ + ``_ :param index: A comma-separated list of index names :param level: Return stats aggregated at cluster, index or shard level diff --git a/elasticsearch/_sync/client/security.py b/elasticsearch/_sync/client/security.py index 35d35a8db..c8f986ab2 100644 --- a/elasticsearch/_sync/client/security.py +++ b/elasticsearch/_sync/client/security.py @@ -47,7 +47,7 @@ def activate_user_profile( Activate a user profile. Create or update a user profile on behalf of another user. - ``_ + ``_ :param grant_type: :param access_token: @@ -105,7 +105,7 @@ def authenticate( and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/_authenticate" @@ -149,7 +149,7 @@ def bulk_delete_role( manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files. - ``_ + ``_ :param names: An array of role names to delete :param refresh: If `true` (the default) then refresh the affected shards to make @@ -207,7 +207,7 @@ def bulk_put_role( way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. - ``_ + ``_ :param roles: A dictionary of role name to RoleDescriptor objects to add or update :param refresh: If `true` (the default) then refresh the affected shards to make @@ -266,7 +266,7 @@ def change_password( Change passwords. Change the passwords of users in the native realm and built-in users. - ``_ + ``_ :param username: The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user. @@ -329,7 +329,7 @@ def clear_api_key_cache( Clear the API key cache. Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. - ``_ + ``_ :param ids: Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns. @@ -372,7 +372,7 @@ def clear_cached_privileges( cache. The cache is also automatically cleared for applications that have their privileges updated. - ``_ + ``_ :param application: A comma-separated list of application names """ @@ -414,7 +414,7 @@ def clear_cached_realms( Clear the user cache. Evict users from the user cache. You can completely clear the cache or evict specific users. - ``_ + ``_ :param realms: Comma-separated list of realms to clear :param usernames: Comma-separated list of usernames to clear from the cache @@ -457,7 +457,7 @@ def clear_cached_roles( """ Clear the roles cache. Evict roles from the native role cache. - ``_ + ``_ :param name: Role name """ @@ -500,7 +500,7 @@ def clear_cached_service_tokens( Clear service account token caches. Evict a subset of all entries from the service account token caches. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -563,7 +563,7 @@ def create_api_key( for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param expiration: Expiration time for the API key. By default, API keys never expire. @@ -650,7 +650,7 @@ def create_cross_cluster_api_key( API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. - ``_ + ``_ :param access: The access to be granted to this API key. The access is composed of permissions for cross-cluster search and cross-cluster replication. At @@ -720,7 +720,7 @@ def create_service_token( Create a service account token. Create a service accounts token for access without requiring basic authentication. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -790,7 +790,7 @@ def delete_privileges( """ Delete application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -846,7 +846,7 @@ def delete_role( """ Delete roles. Delete roles in the native realm. - ``_ + ``_ :param name: Role name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -894,7 +894,7 @@ def delete_role_mapping( """ Delete role mappings. - ``_ + ``_ :param name: Role-mapping name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -945,7 +945,7 @@ def delete_service_token( Delete service account tokens. Delete service account tokens for a service in a specified namespace. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -1003,7 +1003,7 @@ def delete_user( """ Delete users. Delete users from the native realm. - ``_ + ``_ :param username: username :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1051,7 +1051,7 @@ def disable_user( """ Disable users. Disable users in the native realm. - ``_ + ``_ :param username: The username of the user to disable :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1100,7 +1100,7 @@ def disable_user_profile( Disable a user profile. Disable user profiles so that they are not visible in user profile searches. - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1148,7 +1148,7 @@ def enable_user( """ Enable users. Enable users in the native realm. - ``_ + ``_ :param username: The username of the user to enable :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1197,7 +1197,7 @@ def enable_user_profile( Enable a user profile. Enable user profiles to make them visible in user profile searches. - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1242,7 +1242,7 @@ def enroll_kibana( Enroll Kibana. Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/kibana" @@ -1278,7 +1278,7 @@ def enroll_node( Enroll a node. Enroll a new node to allow it to join an existing cluster with security features enabled. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/node" @@ -1325,7 +1325,7 @@ def get_api_key( privileges (including `manage_security`), this API returns all API keys regardless of ownership. - ``_ + ``_ :param active_only: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, @@ -1400,7 +1400,7 @@ def get_builtin_privileges( Get builtin privileges. Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/privilege/_builtin" @@ -1437,7 +1437,7 @@ def get_privileges( """ Get application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -1486,7 +1486,7 @@ def get_role( the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. - ``_ + ``_ :param name: The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about @@ -1534,7 +1534,7 @@ def get_role_mapping( rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files. - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -1583,7 +1583,7 @@ def get_service_accounts( Get service accounts. Get a list of service accounts that match the provided path parameters. - ``_ + ``_ :param namespace: Name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must also omit @@ -1634,7 +1634,7 @@ def get_service_credentials( """ Get service account credentials. - ``_ + ``_ :param namespace: Name of the namespace. :param service: Name of the service name. @@ -1702,7 +1702,7 @@ def get_token( """ Get a token. Create a bearer token for access without requiring basic authentication. - ``_ + ``_ :param grant_type: :param kerberos_ticket: @@ -1761,7 +1761,7 @@ def get_user( """ Get users. Get information about users in the native realm and built-in users. - ``_ + ``_ :param username: An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves @@ -1812,7 +1812,7 @@ def get_user_privileges( """ Get user privileges. - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -1862,7 +1862,7 @@ def get_user_profile( """ Get a user profile. Get a user's profile using the unique profile ID. - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: List of filters for the `data` field of the profile document. To @@ -1940,7 +1940,7 @@ def grant_api_key( API keys never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param api_key: Defines the API key. :param grant_type: The type of grant. Supported grant types are: `access_token`, @@ -2052,6 +2052,7 @@ def has_privileges( "monitor_ml", "monitor_rollup", "monitor_snapshot", + "monitor_stats", "monitor_text_structure", "monitor_transform", "monitor_watcher", @@ -2081,7 +2082,7 @@ def has_privileges( Check user privileges. Determine whether the specified user has a specified list of privileges. - ``_ + ``_ :param user: Username :param application: @@ -2141,7 +2142,7 @@ def has_privileges_user_profile( Check user profile privileges. Determine whether the users associated with the specified user profile IDs have all the requested privileges. - ``_ + ``_ :param privileges: :param uids: A list of profile IDs. The privileges are checked for associated @@ -2210,7 +2211,7 @@ def invalidate_api_key( by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. - ``_ + ``_ :param id: :param ids: A list of API key ids. This parameter cannot be used with any of @@ -2286,7 +2287,7 @@ def invalidate_token( 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. - ``_ + ``_ :param realm_name: :param refresh_token: @@ -2346,7 +2347,7 @@ def put_privileges( """ Create or update application privileges. - ``_ + ``_ :param privileges: :param refresh: If `true` (the default) then refresh the affected shards to make @@ -2392,6 +2393,7 @@ def put_privileges( "global_", "indices", "metadata", + "remote_cluster", "remote_indices", "run_as", "transient_metadata", @@ -2452,6 +2454,7 @@ def put_role( "monitor_ml", "monitor_rollup", "monitor_snapshot", + "monitor_stats", "monitor_text_structure", "monitor_transform", "monitor_watcher", @@ -2481,6 +2484,7 @@ def put_role( refresh: t.Optional[ t.Union[bool, str, t.Literal["false", "true", "wait_for"]] ] = None, + remote_cluster: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None, remote_indices: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None, run_as: t.Optional[t.Sequence[str]] = None, transient_metadata: t.Optional[t.Mapping[str, t.Any]] = None, @@ -2492,7 +2496,7 @@ def put_role( The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless. - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -2508,6 +2512,7 @@ def put_role( :param refresh: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + :param remote_cluster: A list of remote cluster permissions entries. :param remote_indices: A list of remote indices permissions entries. :param run_as: A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, @@ -2549,6 +2554,8 @@ def put_role( __body["indices"] = indices if metadata is not None: __body["metadata"] = metadata + if remote_cluster is not None: + __body["remote_cluster"] = remote_cluster if remote_indices is not None: __body["remote_indices"] = remote_indices if run_as is not None: @@ -2605,7 +2612,7 @@ def put_role_mapping( roles. Roles can be created by using the create or update roles API or roles files. - ``_ + ``_ :param name: Role-mapping name :param enabled: @@ -2694,7 +2701,7 @@ def put_user( when updating an existing user. To change a user’s password without updating any other fields, use the change password API. - ``_ + ``_ :param username: The username of the User :param email: @@ -2792,7 +2799,7 @@ def query_api_keys( Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query. - ``_ + ``_ :param aggregations: Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only @@ -2919,7 +2926,7 @@ def query_role( Find roles with a query. Get roles in a paginated manner. You can optionally filter the results with a query. - ``_ + ``_ :param from_: Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more @@ -3005,7 +3012,7 @@ def query_user( Find users with a query. Get information for users in a paginated manner. You can optionally filter the results with a query. - ``_ + ``_ :param from_: Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more @@ -3083,7 +3090,7 @@ def saml_authenticate( """ Authenticate SAML. Submits a SAML response message to Elasticsearch for consumption. - ``_ + ``_ :param content: The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document. @@ -3145,7 +3152,7 @@ def saml_complete_logout( """ Logout of SAML completely. Verifies the logout response sent from the SAML IdP. - ``_ + ``_ :param ids: A json array with all the valid SAML Request Ids that the caller of the API has for the current user. @@ -3211,7 +3218,7 @@ def saml_invalidate( """ Invalidate SAML. Submits a SAML LogoutRequest message to Elasticsearch for consumption. - ``_ + ``_ :param query_string: The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include @@ -3278,7 +3285,7 @@ def saml_logout( """ Logout of SAML. Submits a request to invalidate an access token and refresh token. - ``_ + ``_ :param token: The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received @@ -3336,7 +3343,7 @@ def saml_prepare_authentication( Prepare SAML authentication. Creates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. - ``_ + ``_ :param acs: The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication @@ -3392,7 +3399,7 @@ def saml_service_provider_metadata( Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider. - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -3439,7 +3446,7 @@ def suggest_user_profiles( Suggest a user profile. Get suggestions for user profiles that match specified search criteria. - ``_ + ``_ :param data: List of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content use `data=` @@ -3523,7 +3530,7 @@ def update_api_key( not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required. - ``_ + ``_ :param id: The ID of the API key to update. :param expiration: Expiration time for the API key. @@ -3595,7 +3602,7 @@ def update_cross_cluster_api_key( Update a cross-cluster API key. Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. - ``_ + ``_ :param id: The ID of the cross-cluster API key to update. :param access: The access to be granted to this API key. The access is composed @@ -3667,7 +3674,7 @@ def update_user_profile_data( Update user profile data. Update specific data for the user profile that is associated with a unique ID. - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: Non-searchable data that you want to associate with the user profile. diff --git a/elasticsearch/_sync/client/slm.py b/elasticsearch/_sync/client/slm.py index 5b6054d72..e780bcc9b 100644 --- a/elasticsearch/_sync/client/slm.py +++ b/elasticsearch/_sync/client/slm.py @@ -38,7 +38,7 @@ def delete_lifecycle( """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove """ @@ -79,7 +79,7 @@ def execute_lifecycle( Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to be executed """ @@ -118,7 +118,7 @@ def execute_retention( """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/_execute_retention" @@ -155,7 +155,7 @@ def get_lifecycle( Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - ``_ + ``_ :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve """ @@ -198,7 +198,7 @@ def get_stats( Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stats" @@ -233,7 +233,7 @@ def get_status( """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/status" @@ -279,7 +279,7 @@ def put_lifecycle( """ Creates or updates a snapshot lifecycle policy. - ``_ + ``_ :param policy_id: ID for the snapshot lifecycle policy you want to create or update. @@ -356,7 +356,7 @@ def start( """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/start" @@ -391,7 +391,7 @@ def stop( """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stop" diff --git a/elasticsearch/_sync/client/snapshot.py b/elasticsearch/_sync/client/snapshot.py index e65dee0ec..69e2336ae 100644 --- a/elasticsearch/_sync/client/snapshot.py +++ b/elasticsearch/_sync/client/snapshot.py @@ -47,7 +47,7 @@ def cleanup_repository( Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -101,7 +101,7 @@ def clone( """ Clones indices from one snapshot into another snapshot in the same repository. - ``_ + ``_ :param repository: A repository name :param snapshot: The name of the snapshot to clone from @@ -184,7 +184,7 @@ def create( """ Creates a snapshot in a repository. - ``_ + ``_ :param repository: Repository for the snapshot. :param snapshot: Name of the snapshot. Must be unique in the repository. @@ -288,7 +288,7 @@ def create_repository( """ Creates a repository. - ``_ + ``_ :param name: A repository name :param repository: @@ -348,7 +348,7 @@ def delete( """ Deletes one or more snapshots. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -399,7 +399,7 @@ def delete_repository( """ Deletes a repository. - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -473,7 +473,7 @@ def get( """ Returns information about a snapshot. - ``_ + ``_ :param repository: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. @@ -585,7 +585,7 @@ def get_repository( """ Returns information about a repository. - ``_ + ``_ :param name: A comma-separated list of repository names :param local: Return local information, do not retrieve the state from master @@ -644,7 +644,7 @@ def repository_verify_integrity( """ Verifies the integrity of the contents of a snapshot repository - ``_ + ``_ :param name: A repository name :param blob_thread_pool_concurrency: Number of threads to use for reading blob @@ -741,7 +741,7 @@ def restore( """ Restores a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -834,7 +834,7 @@ def status( """ Returns information about the status of a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -893,7 +893,7 @@ def verify_repository( """ Verifies a repository. - ``_ + ``_ :param name: A repository name :param master_timeout: Explicit operation timeout for connection to master node diff --git a/elasticsearch/_sync/client/sql.py b/elasticsearch/_sync/client/sql.py index b7da9229c..c82e66662 100644 --- a/elasticsearch/_sync/client/sql.py +++ b/elasticsearch/_sync/client/sql.py @@ -39,9 +39,9 @@ def clear_cursor( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Clears the SQL cursor + Clear an SQL search cursor. - ``_ + ``_ :param cursor: Cursor to clear. """ @@ -84,10 +84,10 @@ def delete_async( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes an async SQL search or a stored synchronous SQL search. If the search - is still running, the API cancels it. + Delete an async SQL search. Delete an async SQL search or a stored synchronous + SQL search. If the search is still running, the API cancels it. - ``_ + ``_ :param id: Identifier for the search. """ @@ -131,10 +131,10 @@ def get_async( ] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status and available results for an async SQL search or stored - synchronous SQL search + Get async SQL search results. Get the current status and available results for + an async SQL search or stored synchronous SQL search. - ``_ + ``_ :param id: Identifier for the search. :param delimiter: Separator for CSV results. The API only supports this parameter @@ -189,10 +189,10 @@ def get_async_status( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the current status of an async SQL search or a stored synchronous SQL - search + Get the async SQL search status. Get the current status of an async SQL search + or a stored synchronous SQL search. - ``_ + ``_ :param id: Identifier for the search. """ @@ -273,9 +273,9 @@ def query( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Executes a SQL request + Get SQL search results. Run an SQL request. - ``_ + ``_ :param catalog: Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. @@ -383,9 +383,10 @@ def translate( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Translates SQL into Elasticsearch queries + Translate SQL into Elasticsearch queries. Translate an SQL search into a search + API request containing Query DSL. - ``_ + ``_ :param query: SQL query to run. :param fetch_size: The maximum number of rows (or entries) to return in one response. diff --git a/elasticsearch/_sync/client/ssl.py b/elasticsearch/_sync/client/ssl.py index 9faa52fad..1f3cb3bed 100644 --- a/elasticsearch/_sync/client/ssl.py +++ b/elasticsearch/_sync/client/ssl.py @@ -53,7 +53,7 @@ def certificates( the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ssl/certificates" diff --git a/elasticsearch/_sync/client/synonyms.py b/elasticsearch/_sync/client/synonyms.py index b82ec67a0..3679e223f 100644 --- a/elasticsearch/_sync/client/synonyms.py +++ b/elasticsearch/_sync/client/synonyms.py @@ -36,9 +36,9 @@ def delete_synonym( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a synonym set + Delete a synonym set. - ``_ + ``_ :param id: The id of the synonyms set to be deleted """ @@ -77,9 +77,9 @@ def delete_synonym_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Deletes a synonym rule in a synonym set + Delete a synonym rule. Delete a synonym rule from a synonym set. - ``_ + ``_ :param set_id: The id of the synonym set to be updated :param rule_id: The id of the synonym rule to be deleted @@ -127,9 +127,9 @@ def get_synonym( size: t.Optional[int] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves a synonym set + Get a synonym set. - ``_ + ``_ :param id: "The id of the synonyms set to be retrieved :param from_: Starting offset for query rules to be retrieved @@ -174,9 +174,9 @@ def get_synonym_rule( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves a synonym rule from a synonym set + Get a synonym rule. Get a synonym rule from a synonym set. - ``_ + ``_ :param set_id: The id of the synonym set to retrieve the synonym rule from :param rule_id: The id of the synonym rule to retrieve @@ -223,9 +223,9 @@ def get_synonyms_sets( size: t.Optional[int] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves a summary of all defined synonym sets + Get all synonym sets. Get a summary of all defined synonym sets. - ``_ + ``_ :param from_: Starting offset :param size: specifies a max number of results to get @@ -272,9 +272,11 @@ def put_synonym( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a synonym set. + Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 + synonym rules per set. If you need to manage more synonym rules, you can create + multiple synonym sets. - ``_ + ``_ :param id: The id of the synonyms set to be created or updated :param synonyms_set: The synonym set information to update @@ -325,9 +327,10 @@ def put_synonym_rule( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates a synonym rule in a synonym set + Create or update a synonym rule. Create or update a synonym rule in a synonym + set. - ``_ + ``_ :param set_id: The id of the synonym set to be updated with the synonym rule :param rule_id: The id of the synonym rule to be updated or created diff --git a/elasticsearch/_sync/client/tasks.py b/elasticsearch/_sync/client/tasks.py index ab15a6c0c..bbdb5c507 100644 --- a/elasticsearch/_sync/client/tasks.py +++ b/elasticsearch/_sync/client/tasks.py @@ -49,7 +49,7 @@ def cancel( """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :param task_id: ID of the task. :param actions: Comma-separated list or wildcard expression of actions used to @@ -110,7 +110,7 @@ def get( Get task information. Returns information about the tasks currently executing in the cluster. - ``_ + ``_ :param task_id: ID of the task. :param timeout: Period to wait for a response. If no response is received before @@ -169,7 +169,7 @@ def list( The task management API returns information about tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :param actions: Comma-separated list or wildcard expression of actions used to limit the request. diff --git a/elasticsearch/_sync/client/text_structure.py b/elasticsearch/_sync/client/text_structure.py index a3e118d8f..a8b8d3c13 100644 --- a/elasticsearch/_sync/client/text_structure.py +++ b/elasticsearch/_sync/client/text_structure.py @@ -53,7 +53,7 @@ def find_structure( Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. - ``_ + ``_ :param text_files: :param charset: The text’s character set. It must be a character set that is @@ -193,7 +193,7 @@ def test_grok_pattern( """ Tests a Grok pattern on some text. - ``_ + ``_ :param grok_pattern: Grok pattern to run on the text. :param text: Lines of text to run the Grok pattern on. diff --git a/elasticsearch/_sync/client/transform.py b/elasticsearch/_sync/client/transform.py index fc5a64a4e..6e7edc4ce 100644 --- a/elasticsearch/_sync/client/transform.py +++ b/elasticsearch/_sync/client/transform.py @@ -41,7 +41,7 @@ def delete_transform( """ Delete a transform. Deletes a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param delete_dest_index: If this value is true, the destination index is deleted @@ -101,7 +101,7 @@ def get_transform( """ Get transforms. Retrieves configuration information for transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -170,7 +170,7 @@ def get_transform_stats( """ Get transform stats. Retrieves usage information for transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -256,7 +256,7 @@ def preview_transform( These values are determined based on the field types of the source index and the transform aggregations. - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -393,7 +393,7 @@ def put_transform( If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -495,7 +495,7 @@ def reset_transform( it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -547,7 +547,7 @@ def schedule_now_transform( the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime. - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Controls the time to wait for the scheduling to take place @@ -611,7 +611,7 @@ def start_transform( privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. - ``_ + ``_ :param transform_id: Identifier for the transform. :param from_: Restricts the set of transformed entities to those changed after @@ -665,7 +665,7 @@ def stop_transform( """ Stop transforms. Stops one or more transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, @@ -765,7 +765,7 @@ def update_transform( which roles the user who updated it had at the time of update and runs with those privileges. - ``_ + ``_ :param transform_id: Identifier for the transform. :param defer_validation: When true, deferrable validations are not run. This @@ -852,7 +852,7 @@ def upgrade_transforms( the role used to read source data and write to the destination index remains unchanged. - ``_ + ``_ :param dry_run: When true, the request checks for updates but does not run them. :param timeout: Period to wait for a response. If no response is received before diff --git a/elasticsearch/_sync/client/watcher.py b/elasticsearch/_sync/client/watcher.py index 1b35a2f97..bf4439f4d 100644 --- a/elasticsearch/_sync/client/watcher.py +++ b/elasticsearch/_sync/client/watcher.py @@ -39,7 +39,7 @@ def ack_watch( """ Acknowledges a watch, manually throttling the execution of the watch's actions. - ``_ + ``_ :param watch_id: Watch ID :param action_id: A comma-separated list of the action ids to be acked @@ -90,7 +90,7 @@ def activate_watch( """ Activates a currently inactive watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -130,7 +130,7 @@ def deactivate_watch( """ Deactivates a currently active watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -170,7 +170,7 @@ def delete_watch( """ Removes a watch from Watcher. - ``_ + ``_ :param id: Watch ID """ @@ -245,7 +245,7 @@ def execute_watch( and control whether a watch record would be written to the watch history after execution. - ``_ + ``_ :param id: Identifier for the watch. :param action_modes: Determines how to handle the watch actions as part of the @@ -328,7 +328,7 @@ def get_watch( """ Retrieves a watch by its ID. - ``_ + ``_ :param id: Watch ID """ @@ -390,7 +390,7 @@ def put_watch( """ Creates a new watch, or updates an existing one. - ``_ + ``_ :param id: Watch ID :param actions: @@ -487,7 +487,7 @@ def query_watches( """ Retrieves stored watches. - ``_ + ``_ :param from_: The offset from the first result to fetch. Needs to be non-negative. :param query: Optional, query filter watches to be returned. @@ -557,7 +557,7 @@ def start( """ Starts Watcher if it is not already running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_start" @@ -614,7 +614,7 @@ def stats( """ Retrieves the current Watcher metrics. - ``_ + ``_ :param metric: Defines which additional metrics are included in the response. :param emit_stacktraces: Defines whether stack traces are generated for each @@ -660,7 +660,7 @@ def stop( """ Stops Watcher if it is running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_stop" diff --git a/elasticsearch/_sync/client/xpack.py b/elasticsearch/_sync/client/xpack.py index f5bd3e897..5bf07a226 100644 --- a/elasticsearch/_sync/client/xpack.py +++ b/elasticsearch/_sync/client/xpack.py @@ -45,7 +45,7 @@ def info( """ Provides general information about the installed X-Pack features. - ``_ + ``_ :param accept_enterprise: If this param is used it must be set to true :param categories: A comma-separated list of the information categories to include @@ -90,7 +90,7 @@ def usage( This API provides information about which features are currently enabled and available under the current license and some usage statistics. - ``_ + ``_ :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