From 9ecf7331794952e031f76f1c4b57972f31c81517 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Thu, 22 Dec 2022 15:39:56 -0500 Subject: [PATCH] Generate API code for 8.6 --- elasticsearch/_async/client/__init__.py | 84 +++++----- elasticsearch/_async/client/async_search.py | 8 +- elasticsearch/_async/client/autoscaling.py | 8 +- elasticsearch/_async/client/cat.py | 58 +++---- elasticsearch/_async/client/ccr.py | 26 ++-- elasticsearch/_async/client/cluster.py | 30 ++-- .../_async/client/dangling_indices.py | 6 +- elasticsearch/_async/client/enrich.py | 10 +- elasticsearch/_async/client/eql.py | 8 +- elasticsearch/_async/client/features.py | 4 +- elasticsearch/_async/client/fleet.py | 2 +- elasticsearch/_async/client/graph.py | 2 +- elasticsearch/_async/client/ilm.py | 22 +-- elasticsearch/_async/client/indices.py | 108 ++++++------- elasticsearch/_async/client/ingest.py | 12 +- elasticsearch/_async/client/license.py | 14 +- elasticsearch/_async/client/logstash.py | 6 +- elasticsearch/_async/client/migration.py | 6 +- elasticsearch/_async/client/ml.py | 144 +++++++++--------- elasticsearch/_async/client/monitoring.py | 2 +- elasticsearch/_async/client/nodes.py | 14 +- elasticsearch/_async/client/rollup.py | 16 +- .../_async/client/searchable_snapshots.py | 8 +- elasticsearch/_async/client/security.py | 102 ++++++------- elasticsearch/_async/client/slm.py | 18 +-- elasticsearch/_async/client/snapshot.py | 22 +-- elasticsearch/_async/client/sql.py | 12 +- elasticsearch/_async/client/ssl.py | 2 +- elasticsearch/_async/client/tasks.py | 6 +- elasticsearch/_async/client/text_structure.py | 2 +- elasticsearch/_async/client/transform.py | 20 +-- elasticsearch/_async/client/watcher.py | 22 +-- elasticsearch/_async/client/xpack.py | 4 +- elasticsearch/_sync/client/__init__.py | 84 +++++----- elasticsearch/_sync/client/async_search.py | 8 +- elasticsearch/_sync/client/autoscaling.py | 8 +- elasticsearch/_sync/client/cat.py | 58 +++---- elasticsearch/_sync/client/ccr.py | 26 ++-- elasticsearch/_sync/client/cluster.py | 30 ++-- .../_sync/client/dangling_indices.py | 6 +- elasticsearch/_sync/client/enrich.py | 10 +- elasticsearch/_sync/client/eql.py | 8 +- elasticsearch/_sync/client/features.py | 4 +- elasticsearch/_sync/client/fleet.py | 2 +- elasticsearch/_sync/client/graph.py | 2 +- elasticsearch/_sync/client/ilm.py | 22 +-- elasticsearch/_sync/client/indices.py | 108 ++++++------- elasticsearch/_sync/client/ingest.py | 12 +- elasticsearch/_sync/client/license.py | 14 +- elasticsearch/_sync/client/logstash.py | 6 +- elasticsearch/_sync/client/migration.py | 6 +- elasticsearch/_sync/client/ml.py | 144 +++++++++--------- elasticsearch/_sync/client/monitoring.py | 2 +- elasticsearch/_sync/client/nodes.py | 14 +- elasticsearch/_sync/client/rollup.py | 16 +- .../_sync/client/searchable_snapshots.py | 8 +- elasticsearch/_sync/client/security.py | 102 ++++++------- elasticsearch/_sync/client/slm.py | 18 +-- elasticsearch/_sync/client/snapshot.py | 22 +-- elasticsearch/_sync/client/sql.py | 12 +- elasticsearch/_sync/client/ssl.py | 2 +- elasticsearch/_sync/client/tasks.py | 6 +- elasticsearch/_sync/client/text_structure.py | 2 +- elasticsearch/_sync/client/transform.py | 20 +-- elasticsearch/_sync/client/watcher.py | 22 +-- elasticsearch/_sync/client/xpack.py | 4 +- 66 files changed, 814 insertions(+), 802 deletions(-) diff --git a/elasticsearch/_async/client/__init__.py b/elasticsearch/_async/client/__init__.py index e079807c2..8f7c12e5d 100644 --- a/elasticsearch/_async/client/__init__.py +++ b/elasticsearch/_async/client/__init__.py @@ -640,7 +640,7 @@ async def bulk( """ Allows to perform multiple index/update/delete operations in a single request. - ``_ + ``_ :param operations: :param index: Default index for items which don't provide one @@ -725,7 +725,7 @@ async def clear_scroll( """ Explicitly clears the search context for a scroll. - ``_ + ``_ :param scroll_id: """ @@ -768,7 +768,7 @@ async def close_point_in_time( """ Close a point in time - ``_ + ``_ :param id: """ @@ -845,7 +845,7 @@ async def count( """ Returns number of documents matching a query. - ``_ + ``_ :param index: A comma-separated list of indices to restrict the results :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -962,7 +962,7 @@ async def create( Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -1047,7 +1047,7 @@ async def delete( """ Removes a document from the index. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1175,7 +1175,7 @@ async def delete_by_query( """ Deletes documents matching the provided query. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -1339,7 +1339,7 @@ async def delete_by_query_rethrottle( """ Changes the number of requests per second for a particular Delete By Query operation. - ``_ + ``_ :param task_id: The task id to rethrottle :param requests_per_second: The throttle to set on this request in floating sub-requests @@ -1383,7 +1383,7 @@ async def delete_script( """ Deletes a script. - ``_ + ``_ :param id: Script ID :param master_timeout: Specify timeout for connection to master @@ -1452,7 +1452,7 @@ async def exists( """ Returns information about whether a document exists in an index. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1552,7 +1552,7 @@ async def exists_source( """ Returns information about whether a document source exists in an index. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1653,7 +1653,7 @@ async def explain( """ Returns information about why a specific matches (or doesn't match) a query. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1774,7 +1774,7 @@ async def field_caps( """ Returns the information about the capabilities of fields among multiple indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -1886,7 +1886,7 @@ async def get( """ Returns a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -1966,7 +1966,7 @@ async def get_script( """ Returns a script. - ``_ + ``_ :param id: Script ID :param master_timeout: Specify timeout for connection to master @@ -2004,7 +2004,7 @@ async def get_script_context( """ Returns all script contexts. - ``_ + ``_ """ __path = "/_script_context" __query: t.Dict[str, t.Any] = {} @@ -2035,7 +2035,7 @@ async def get_script_languages( """ Returns available script types, languages and contexts - ``_ + ``_ """ __path = "/_script_language" __query: t.Dict[str, t.Any] = {} @@ -2094,7 +2094,7 @@ async def get_source( """ Returns the source of a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2191,7 +2191,7 @@ async def index( """ Creates or updates a document in an index. - ``_ + ``_ :param index: The name of the index :param document: @@ -2282,7 +2282,7 @@ async def info( """ Returns basic information about the cluster. - ``_ + ``_ """ __path = "/" __query: t.Dict[str, t.Any] = {} @@ -2337,7 +2337,7 @@ async def knn_search( """ Performs a kNN search. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or to perform the operation on all indices @@ -2440,7 +2440,7 @@ async def mget( """ Allows to get multiple documents in one request. - ``_ + ``_ :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. @@ -2557,7 +2557,7 @@ async def msearch( """ Allows to execute several search operations in one request. - ``_ + ``_ :param searches: :param index: Comma-separated list of data streams, indices, and index aliases @@ -2670,7 +2670,7 @@ async def msearch_template( """ Allows to execute several search template operations in one request. - ``_ + ``_ :param search_templates: :param index: A comma-separated list of index names to use as default @@ -2754,7 +2754,7 @@ async def mtermvectors( """ Returns multiple termvectors in one request. - ``_ + ``_ :param index: The index in which the document resides. :param docs: @@ -2849,7 +2849,7 @@ async def open_point_in_time( """ Open a point in time that can be used in subsequent searches - ``_ + ``_ :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 @@ -2903,7 +2903,7 @@ async def put_script( """ Creates or updates a script. - ``_ + ``_ :param id: Script ID :param script: @@ -2985,7 +2985,7 @@ async def rank_eval( Allows to 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. @@ -3072,7 +3072,7 @@ async def reindex( source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. - ``_ + ``_ :param dest: :param source: @@ -3161,7 +3161,7 @@ async def reindex_rethrottle( """ Changes the number of requests per second for a particular Reindex operation. - ``_ + ``_ :param task_id: The task id to rethrottle :param requests_per_second: The throttle to set on this request in floating sub-requests @@ -3207,7 +3207,7 @@ async def render_search_template( """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :param id: The id of the stored search template :param file: @@ -3262,7 +3262,7 @@ async def scripts_painless_execute( """ Allows an arbitrary script to be executed and a result to be returned - ``_ + ``_ :param context: :param context_setup: @@ -3313,7 +3313,7 @@ async def scroll( """ Allows to retrieve a large numbers of results from a single search request. - ``_ + ``_ :param scroll_id: Scroll ID of the search. :param rest_total_hits_as_int: If true, the API response’s hit.total property @@ -3487,7 +3487,7 @@ async def search( """ Returns results matching a query. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -3816,7 +3816,7 @@ async def search_mvt( Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, or aliases to search :param field: Field containing geospatial data to return @@ -3957,7 +3957,7 @@ async def search_shards( Returns information about the indices and shards that a search request would be executed against. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -4057,7 +4057,7 @@ async def search_template( """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). @@ -4168,7 +4168,7 @@ async def terms_enum( the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported. @@ -4262,7 +4262,7 @@ async def termvectors( Returns information and statistics about terms in the fields of a particular document. - ``_ + ``_ :param index: The index in which the document resides. :param id: The id of the document, when not specified a doc param should be supplied. @@ -4389,7 +4389,7 @@ async def update( """ Updates a document with a script or partial document. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -4558,7 +4558,7 @@ async def update_by_query( Performs an update on every document in the index without changing the source, for example to pick up a mapping change. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -4734,7 +4734,7 @@ async def update_by_query_rethrottle( """ Changes the number of requests per second for a particular Update By Query operation. - ``_ + ``_ :param task_id: The task id to rethrottle :param requests_per_second: The throttle to set on this request in floating sub-requests diff --git a/elasticsearch/_async/client/async_search.py b/elasticsearch/_async/client/async_search.py index 76b395f57..9cf0f4b53 100644 --- a/elasticsearch/_async/client/async_search.py +++ b/elasticsearch/_async/client/async_search.py @@ -40,7 +40,7 @@ async def delete( Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :param id: The async search ID """ @@ -82,7 +82,7 @@ async def get( Retrieves the results of a previously submitted async search request given its ID. - ``_ + ``_ :param id: The async search ID :param keep_alive: Specify the time interval in which the results (partial or @@ -131,7 +131,7 @@ async def status( Retrieves the status of a previously submitted async search request given its ID. - ``_ + ``_ :param id: The async search ID """ @@ -295,7 +295,7 @@ async def submit( """ Executes a search request asynchronously. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py index 939bcdf16..74de1412d 100644 --- a/elasticsearch/_async/client/autoscaling.py +++ b/elasticsearch/_async/client/autoscaling.py @@ -40,7 +40,7 @@ async def delete_autoscaling_policy( Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ :param name: the name of the autoscaling policy """ @@ -76,7 +76,7 @@ async def get_autoscaling_capacity( Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ """ __path = "/_autoscaling/capacity" __query: t.Dict[str, t.Any] = {} @@ -109,7 +109,7 @@ async def get_autoscaling_policy( Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ :param name: the name of the autoscaling policy """ @@ -149,7 +149,7 @@ async def put_autoscaling_policy( Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ :param name: the name of the autoscaling policy :param policy: diff --git a/elasticsearch/_async/client/cat.py b/elasticsearch/_async/client/cat.py index f3dd016a3..3df1bc692 100644 --- a/elasticsearch/_async/client/cat.py +++ b/elasticsearch/_async/client/cat.py @@ -67,7 +67,7 @@ async def aliases( Shows information about currently configured aliases to indices including filter and routing infos. - ``_ + ``_ :param name: A comma-separated list of alias names to return :param expand_wildcards: Whether to expand wildcard expression to concrete indices @@ -151,7 +151,7 @@ async def allocation( Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information @@ -229,7 +229,7 @@ async def component_templates( """ Returns information about existing component_templates templates. - ``_ + ``_ :param name: A pattern that returned component template names must match :param format: Specifies the format to return the columnar data in, can be set @@ -304,7 +304,7 @@ async def count( Provides quick access to the document count of the entire cluster, or individual indices. - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param format: Specifies the format to return the columnar data in, can be set @@ -384,7 +384,7 @@ async def fielddata( Shows how much heap memory is currently being used by fielddata on every data node in the cluster. - ``_ + ``_ :param fields: A comma-separated list of fields to return the fielddata size :param bytes: The unit in which to display byte values @@ -461,7 +461,7 @@ async def health( """ Returns a concise representation of the cluster health. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -533,7 +533,7 @@ async def 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`. @@ -622,13 +622,16 @@ async def indices( pretty: t.Optional[bool] = None, pri: t.Optional[bool] = None, s: t.Optional[t.Union[str, t.Union[t.List[str], t.Tuple[str, ...]]]] = None, + time: t.Optional[ + t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str] + ] = None, v: t.Optional[bool] = None, ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]: """ Returns information about indices: number of primaries and replicas, document counts, disk size, ... - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param bytes: The unit in which to display byte values @@ -652,6 +655,7 @@ async def indices( :param s: List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. + :param time: The unit in which to display time values :param v: When set to `true` will enable verbose output. """ if index not in SKIP_IN_PATH: @@ -689,6 +693,8 @@ async def indices( __query["pri"] = pri if s is not None: __query["s"] = s + if time is not None: + __query["time"] = time if v is not None: __query["v"] = v __headers = {"accept": "text/plain,application/json"} @@ -719,7 +725,7 @@ async def master( """ Returns information about the master node. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -838,7 +844,7 @@ async def ml_data_frame_analytics( """ Gets configuration and usage information about data frame analytics jobs. - ``_ + ``_ :param id: The ID of the data frame analytics to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -969,7 +975,7 @@ async def ml_datafeeds( """ Gets configuration and usage information about datafeeds. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1106,7 +1112,7 @@ async def ml_jobs( """ Gets configuration and usage information about anomaly detection jobs. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param allow_no_match: Specifies what to do when the request: * Contains wildcard @@ -1246,7 +1252,7 @@ async def ml_trained_models( """ Gets configuration and usage information about inference trained models. - ``_ + ``_ :param model_id: The ID of the trained models stats to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -1331,7 +1337,7 @@ async def nodeattrs( """ Returns information about custom node attributes. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1404,7 +1410,7 @@ async def nodes( """ Returns basic statistics about performance of cluster nodes. - ``_ + ``_ :param bytes: The unit in which to display byte values :param format: Specifies the format to return the columnar data in, can be set @@ -1480,7 +1486,7 @@ async def pending_tasks( """ Returns a concise representation of the cluster pending tasks. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1549,7 +1555,7 @@ async def plugins( """ Returns information about installed plugins across nodes node. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1624,7 +1630,7 @@ async def recovery( """ Returns information about index shard recoveries, both on-going completed. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names to limit the returned information @@ -1708,7 +1714,7 @@ async def repositories( """ Returns information about snapshot repositories registered in the cluster. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1781,7 +1787,7 @@ async def segments( """ Provides low-level information about the segments in the shards of an index. - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param bytes: The unit in which to display byte values @@ -1861,7 +1867,7 @@ async def shards( """ Provides a detailed view of shard allocation on nodes. - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param bytes: The unit in which to display byte values @@ -1941,7 +1947,7 @@ async def snapshots( """ Returns all snapshots in a specific repository. - ``_ + ``_ :param repository: Name of repository from which to fetch the snapshot information :param format: Specifies the format to return the columnar data in, can be set @@ -2022,7 +2028,7 @@ async def tasks( Returns information about the tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :param actions: A comma-separated list of actions that should be returned. Leave empty to return all. @@ -2105,7 +2111,7 @@ async def templates( """ Returns information about existing templates. - ``_ + ``_ :param name: A pattern that returned template names must match :param format: Specifies the format to return the columnar data in, can be set @@ -2185,7 +2191,7 @@ async def thread_pool( Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. - ``_ + ``_ :param thread_pool_patterns: List of thread pool names used to limit the request. Accepts wildcard expressions. @@ -2315,7 +2321,7 @@ async def transforms( """ Gets configuration and usage information about transforms. - ``_ + ``_ :param transform_id: The id of the transform for which to get stats. '_all' or '*' implies all transforms diff --git a/elasticsearch/_async/client/ccr.py b/elasticsearch/_async/client/ccr.py index 4ebda28a9..3c5113fc3 100644 --- a/elasticsearch/_async/client/ccr.py +++ b/elasticsearch/_async/client/ccr.py @@ -39,7 +39,7 @@ async def delete_auto_follow_pattern( """ Deletes auto-follow patterns. - ``_ + ``_ :param name: The name of the auto follow pattern. """ @@ -96,7 +96,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: @@ -180,7 +180,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 @@ -218,7 +218,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 @@ -261,7 +261,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 @@ -312,7 +312,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. @@ -350,7 +350,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. @@ -388,7 +388,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. @@ -452,7 +452,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 @@ -566,7 +566,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. @@ -619,7 +619,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: @@ -693,7 +693,7 @@ async def stats( """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ __path = "/_ccr/stats" __query: t.Dict[str, t.Any] = {} @@ -726,7 +726,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 5db0b7df6..8a3421c96 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. @@ -111,7 +111,7 @@ async def delete_component_template( """ Deletes a component template - ``_ + ``_ :param name: Comma-separated list or wildcard expression of component template names used to limit the request. @@ -154,7 +154,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 @@ -199,7 +199,7 @@ async def exists_component_template( """ Returns information about whether a particular component template exist - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported. @@ -251,7 +251,7 @@ async def get_component_template( """ Returns one or more component templates - ``_ + ``_ :param name: The comma separated names of the component templates :param flat_settings: @@ -303,7 +303,7 @@ async def get_settings( """ Returns cluster settings. - ``_ + ``_ :param flat_settings: Return settings in flat format (default: false) :param include_defaults: Whether to return all default clusters setting. @@ -389,7 +389,7 @@ async def health( """ Returns basic information about the health of the cluster. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target @@ -484,7 +484,7 @@ async def pending_tasks( Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. - ``_ + ``_ :param local: Return local information, do not retrieve the state from master node (default: false) @@ -530,7 +530,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 @@ -591,7 +591,7 @@ async def put_component_template( """ Creates or updates a component template - ``_ + ``_ :param name: The name of the template :param template: @@ -663,7 +663,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 @@ -711,7 +711,7 @@ async def remote_info( """ Returns the information about configured remote clusters. - ``_ + ``_ """ __path = "/_remote/info" __query: t.Dict[str, t.Any] = {} @@ -757,7 +757,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 @@ -854,7 +854,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 @@ -932,7 +932,7 @@ async def stats( """ Returns high-level overview of cluster statistics. - ``_ + ``_ :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/dangling_indices.py b/elasticsearch/_async/client/dangling_indices.py index fecaa9948..67cc8d20f 100644 --- a/elasticsearch/_async/client/dangling_indices.py +++ b/elasticsearch/_async/client/dangling_indices.py @@ -44,7 +44,7 @@ async def delete_dangling_index( """ Deletes the specified dangling index - ``_ + ``_ :param index_uuid: The UUID of the dangling index :param accept_data_loss: Must be set to true in order to delete the dangling @@ -97,7 +97,7 @@ async def import_dangling_index( """ Imports the specified dangling index - ``_ + ``_ :param index_uuid: The UUID of the dangling index :param accept_data_loss: Must be set to true in order to import the dangling @@ -144,7 +144,7 @@ async def list_dangling_indices( """ Returns all dangling indices. - ``_ + ``_ """ __path = "/_dangling" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_async/client/enrich.py b/elasticsearch/_async/client/enrich.py index 088ec6812..2bc15c82a 100644 --- a/elasticsearch/_async/client/enrich.py +++ b/elasticsearch/_async/client/enrich.py @@ -39,7 +39,7 @@ async def delete_policy( """ Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :param name: The name of the enrich policy """ @@ -76,7 +76,7 @@ async def execute_policy( """ Creates the enrich index for an existing enrich policy. - ``_ + ``_ :param name: The name of the enrich policy :param wait_for_completion: Should the request should block until the execution @@ -116,7 +116,7 @@ async def get_policy( """ Gets information about an enrich policy. - ``_ + ``_ :param name: A comma-separated list of enrich policy names """ @@ -158,7 +158,7 @@ async def put_policy( """ Creates a new enrich policy. - ``_ + ``_ :param name: The name of the enrich policy :param geo_match: @@ -204,7 +204,7 @@ async def stats( Gets enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ __path = "/_enrich/_stats" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_async/client/eql.py b/elasticsearch/_async/client/eql.py index 99ec0d9b1..6841aaed3 100644 --- a/elasticsearch/_async/client/eql.py +++ b/elasticsearch/_async/client/eql.py @@ -40,7 +40,7 @@ async def delete( Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :param id: Identifier for the search to delete. """ @@ -80,7 +80,7 @@ async def get( """ Returns async results from previously executed Event Query Language (EQL) search - ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -127,7 +127,7 @@ async def get_status( Returns the status of a previously submitted async or stored Event Query Language (EQL) search - ``_ + ``_ :param id: Identifier for the search. """ @@ -215,7 +215,7 @@ async def search( """ Returns results matching a query expressed in Event Query Language (EQL) - ``_ + ``_ :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/features.py b/elasticsearch/_async/client/features.py index fe75e9180..b7d1fcee1 100644 --- a/elasticsearch/_async/client/features.py +++ b/elasticsearch/_async/client/features.py @@ -39,7 +39,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 = "/_features" __query: t.Dict[str, t.Any] = {} @@ -70,7 +70,7 @@ async def reset_features( """ Resets the internal state of features, usually by deleting system indices - ``_ + ``_ """ __path = "/_features/_reset" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_async/client/fleet.py b/elasticsearch/_async/client/fleet.py index 8b2cd7abf..9f9094b52 100644 --- a/elasticsearch/_async/client/fleet.py +++ b/elasticsearch/_async/client/fleet.py @@ -44,7 +44,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 e1f21fe26..88ad1f075 100644 --- a/elasticsearch/_async/client/graph.py +++ b/elasticsearch/_async/client/graph.py @@ -50,7 +50,7 @@ async def explore( Explore extracted and summarized information about the documents and terms in an index. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_async/client/ilm.py b/elasticsearch/_async/client/ilm.py index cf25b495d..f67817751 100644 --- a/elasticsearch/_async/client/ilm.py +++ b/elasticsearch/_async/client/ilm.py @@ -44,7 +44,7 @@ async def delete_lifecycle( Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -96,7 +96,7 @@ async def explain_lifecycle( Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -157,7 +157,7 @@ async def get_lifecycle( Returns the specified policy definition. Includes the policy version and last modified date. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -202,7 +202,7 @@ async def get_status( """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ __path = "/_ilm/status" __query: t.Dict[str, t.Any] = {} @@ -239,7 +239,7 @@ async def migrate_to_data_tiers( Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing - ``_ + ``_ :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 @@ -292,7 +292,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: @@ -346,7 +346,7 @@ async def put_lifecycle( """ Creates a lifecycle policy - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -399,7 +399,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 """ @@ -435,7 +435,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 @@ -475,7 +475,7 @@ async def start( """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ :param master_timeout: :param timeout: @@ -518,7 +518,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 f4cc407eb..90f1dbce1 100644 --- a/elasticsearch/_async/client/indices.py +++ b/elasticsearch/_async/client/indices.py @@ -64,7 +64,7 @@ async def add_block( """ Adds a block to an index. - ``_ + ``_ :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) @@ -144,7 +144,7 @@ async def analyze( Performs the analysis process on a text and return the tokens breakdown of the text. - ``_ + ``_ :param index: The name of the index to scope the operation :param analyzer: @@ -239,7 +239,7 @@ async def clear_cache( """ Clears all or specific caches for one or more indices. - ``_ + ``_ :param index: A comma-separated list of index name to limit the operation :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -314,7 +314,7 @@ async def clone( """ Clones an index - ``_ + ``_ :param index: The name of the source index to clone :param target: The name of the target index to clone into @@ -401,7 +401,7 @@ async def close( """ Closes an index. - ``_ + ``_ :param index: A comma separated list of indices to close :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -472,7 +472,7 @@ async def create( """ Creates an index with optional settings and mappings. - ``_ + ``_ :param index: The name of the index :param aliases: @@ -533,7 +533,7 @@ async def create_data_stream( """ Creates a data stream - ``_ + ``_ :param name: The name of the data stream """ @@ -587,7 +587,7 @@ async def data_streams_stats( """ Provides statistics on operations happening in a data stream. - ``_ + ``_ :param name: A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams @@ -652,7 +652,7 @@ async def delete( """ Deletes an index. - ``_ + ``_ :param index: A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices @@ -711,7 +711,7 @@ async def delete_alias( """ Deletes an alias. - ``_ + ``_ :param index: A comma-separated list of index names (supports wildcards); use `_all` for all indices @@ -776,7 +776,7 @@ async def delete_data_stream( """ Deletes a data stream. - ``_ + ``_ :param name: A comma-separated list of data streams to delete; use `*` to delete all data streams @@ -821,7 +821,7 @@ async def delete_index_template( """ Deletes an index template. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -871,7 +871,7 @@ async def delete_template( """ Deletes an index template. - ``_ + ``_ :param name: The name of the template :param master_timeout: Specify timeout for connection to master @@ -935,7 +935,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 @@ -1003,7 +1003,7 @@ async def downsample( """ Downsample an index - ``_ + ``_ :param index: The index to downsample :param target_index: The name of the target index to store downsampled data @@ -1069,7 +1069,7 @@ async def exists( """ Returns information about whether a particular index exists. - ``_ + ``_ :param index: A comma-separated list of index names :param allow_no_indices: Ignore if a wildcard expression resolves to no concrete @@ -1149,7 +1149,7 @@ async def exists_alias( """ Returns information about whether a particular alias exists. - ``_ + ``_ :param name: A comma-separated list of alias names to return :param index: A comma-separated list of index names to filter aliases @@ -1211,7 +1211,7 @@ async def exists_index_template( """ Returns information about whether a particular index template exists. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1258,7 +1258,7 @@ async def exists_template( """ 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) @@ -1334,7 +1334,7 @@ async def field_usage_stats( """ Returns the field usage stats for each field of an index - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1428,7 +1428,7 @@ async def flush( """ Performs the flush operation on one or more indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string for all indices @@ -1515,7 +1515,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 @@ -1622,7 +1622,7 @@ async def get( """ Returns information about one or more indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -1717,7 +1717,7 @@ async def get_alias( """ Returns an alias. - ``_ + ``_ :param index: A comma-separated list of index names to filter aliases :param name: A comma-separated list of alias names to return @@ -1794,7 +1794,7 @@ async def get_data_stream( """ Returns data streams. - ``_ + ``_ :param name: A comma-separated list of data streams to get; use `*` to get all data streams @@ -1859,7 +1859,7 @@ async def get_field_mapping( """ Returns mapping for one or more fields. - ``_ + ``_ :param fields: A comma-separated list of fields :param index: A comma-separated list of index names @@ -1927,7 +1927,7 @@ async def get_index_template( """ Returns an index template. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2002,7 +2002,7 @@ async def get_mapping( """ Returns mappings for one or more indices. - ``_ + ``_ :param index: A comma-separated list of index names :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -2086,7 +2086,7 @@ async def get_settings( """ Returns settings for 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 @@ -2161,7 +2161,7 @@ async def get_template( """ Returns an index template. - ``_ + ``_ :param name: The comma separated names of the index templates :param flat_settings: Return settings in flat format (default: false) @@ -2208,7 +2208,7 @@ async def migrate_to_data_stream( """ Migrates an alias to a data stream - ``_ + ``_ :param name: The name of the alias to migrate """ @@ -2248,7 +2248,7 @@ async def modify_data_stream( """ Modifies a data stream - ``_ + ``_ :param actions: Actions to perform. """ @@ -2314,7 +2314,7 @@ async def open( """ Opens an index. - ``_ + ``_ :param index: A comma separated list of indices to open :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -2374,7 +2374,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 """ @@ -2422,7 +2422,7 @@ async def put_alias( """ Creates or updates an alias. - ``_ + ``_ :param index: A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. @@ -2501,7 +2501,7 @@ async def put_index_template( """ Creates or updates an index template. - ``_ + ``_ :param name: Index or template name :param composed_of: @@ -2619,7 +2619,7 @@ async def put_mapping( """ Updates the index mappings. - ``_ + ``_ :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. @@ -2748,7 +2748,7 @@ async def put_settings( """ Updates the index settings. - ``_ + ``_ :param settings: :param index: A comma-separated list of index names; use `_all` or empty string @@ -2832,7 +2832,7 @@ async def put_template( """ Creates or updates an index template. - ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -2909,7 +2909,7 @@ async def recovery( """ Returns information about ongoing index shard recoveries. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -2973,7 +2973,7 @@ async def refresh( """ Performs the refresh operation in 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 @@ -3044,7 +3044,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 @@ -3111,7 +3111,7 @@ async def resolve_index( """ Returns information about any matching indices, aliases, and data streams - ``_ + ``_ :param name: A comma-separated list of names or wildcard expressions :param expand_wildcards: Whether wildcard expressions should get expanded to @@ -3167,7 +3167,7 @@ async def rollover( Updates an alias to point to a new index when the existing index is considered to be too large or too old. - ``_ + ``_ :param alias: The name of the alias to rollover :param new_index: The name of the rollover index @@ -3261,7 +3261,7 @@ async def segments( """ Provides low-level information about segments in a Lucene index. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -3346,7 +3346,7 @@ async def shard_stores( """ Provides store information for shard copies of 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 @@ -3412,7 +3412,7 @@ async def shrink( """ Allow to shrink an existing index into a new index with fewer primary shards. - ``_ + ``_ :param index: The name of the source index to shrink :param target: The name of the target index to shrink into @@ -3489,7 +3489,7 @@ async def simulate_index_template( """ Simulate matching the given index name against the index templates in the system - ``_ + ``_ :param name: Index or template name to simulate :param allow_auto_create: @@ -3572,7 +3572,7 @@ async def simulate_template( """ Simulate resolving the given template name or body - ``_ + ``_ :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 @@ -3640,7 +3640,7 @@ async def split( """ Allows you to split an existing index into a new index with more primary shards. - ``_ + ``_ :param index: The name of the source index to split :param target: The name of the target index to split into @@ -3739,7 +3739,7 @@ async def stats( """ Provides statistics on operations happening in an index. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -3847,7 +3847,7 @@ async def unfreeze( Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. - ``_ + ``_ :param index: The name of the index to unfreeze :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -3914,7 +3914,7 @@ async def update_aliases( """ Updates index aliases. - ``_ + ``_ :param actions: :param master_timeout: Specify timeout for connection to master @@ -3989,7 +3989,7 @@ async def validate_query( """ Allows a user to validate a potentially expensive query without executing it. - ``_ + ``_ :param index: A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_async/client/ingest.py b/elasticsearch/_async/client/ingest.py index d3cbebe90..d5031231f 100644 --- a/elasticsearch/_async/client/ingest.py +++ b/elasticsearch/_async/client/ingest.py @@ -43,7 +43,7 @@ async def delete_pipeline( """ Deletes a pipeline. - ``_ + ``_ :param id: Pipeline ID :param master_timeout: Explicit operation timeout for connection to master node @@ -84,7 +84,7 @@ async def geo_ip_stats( """ Returns statistical information about geoip databases - ``_ + ``_ """ __path = "/_ingest/geoip/stats" __query: t.Dict[str, t.Any] = {} @@ -120,7 +120,7 @@ async def get_pipeline( """ Returns a pipeline. - ``_ + ``_ :param id: Comma separated list of pipeline ids. Wildcards supported :param master_timeout: Explicit operation timeout for connection to master node @@ -162,7 +162,7 @@ async def processor_grok( """ Returns a list of the built-in patterns. - ``_ + ``_ """ __path = "/_ingest/processor/grok" __query: t.Dict[str, t.Any] = {} @@ -211,7 +211,7 @@ async def put_pipeline( """ Creates or updates a pipeline. - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param description: Description of the ingest pipeline. @@ -292,7 +292,7 @@ async def simulate( """ Allows to simulate a pipeline with example documents. - ``_ + ``_ :param id: Pipeline ID :param docs: diff --git a/elasticsearch/_async/client/license.py b/elasticsearch/_async/client/license.py index b8f9ec57e..a85beeeff 100644 --- a/elasticsearch/_async/client/license.py +++ b/elasticsearch/_async/client/license.py @@ -38,7 +38,7 @@ async def delete( """ Deletes licensing information for the cluster - ``_ + ``_ """ __path = "/_license" __query: t.Dict[str, t.Any] = {} @@ -71,7 +71,7 @@ async def get( """ Retrieves licensing information for the cluster - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -113,7 +113,7 @@ async def get_basic_status( """ Retrieves information about the status of the basic license. - ``_ + ``_ """ __path = "/_license/basic_status" __query: t.Dict[str, t.Any] = {} @@ -144,7 +144,7 @@ async def get_trial_status( """ Retrieves information about the status of the trial license. - ``_ + ``_ """ __path = "/_license/trial_status" __query: t.Dict[str, t.Any] = {} @@ -182,7 +182,7 @@ async def post( """ Updates the license for the cluster. - ``_ + ``_ :param acknowledge: Specifies whether you acknowledge the license changes. :param license: @@ -230,7 +230,7 @@ async def post_start_basic( """ Starts an indefinite basic license. - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -268,7 +268,7 @@ async def post_start_trial( """ starts a limited time trial license. - ``_ + ``_ :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 4427775e3..19a95d70b 100644 --- a/elasticsearch/_async/client/logstash.py +++ b/elasticsearch/_async/client/logstash.py @@ -39,7 +39,7 @@ async def delete_pipeline( """ Deletes Logstash Pipelines used by Central Management - ``_ + ``_ :param id: The ID of the Pipeline """ @@ -75,7 +75,7 @@ async def get_pipeline( """ Retrieves Logstash Pipelines used by Central Management - ``_ + ``_ :param id: A comma-separated list of Pipeline IDs """ @@ -114,7 +114,7 @@ async def put_pipeline( """ Adds and updates Logstash Pipelines used for Central Management - ``_ + ``_ :param id: The ID of the Pipeline :param pipeline: diff --git a/elasticsearch/_async/client/migration.py b/elasticsearch/_async/client/migration.py index 57e83483a..af67dc145 100644 --- a/elasticsearch/_async/client/migration.py +++ b/elasticsearch/_async/client/migration.py @@ -41,7 +41,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. @@ -78,7 +78,7 @@ async def get_feature_upgrade_status( """ Find out whether system features need to be upgraded or not - ``_ + ``_ """ __path = "/_migration/system_features" __query: t.Dict[str, t.Any] = {} @@ -109,7 +109,7 @@ async def post_feature_upgrade( """ Begin upgrades for system features - ``_ + ``_ """ __path = "/_migration/system_features" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_async/client/ml.py b/elasticsearch/_async/client/ml.py index a806433a3..e4bc4edd6 100644 --- a/elasticsearch/_async/client/ml.py +++ b/elasticsearch/_async/client/ml.py @@ -39,7 +39,7 @@ async def clear_trained_model_deployment_cache( """ Clear the cached results from a trained model deployment - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -81,7 +81,7 @@ async def close_job( Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. - ``_ + ``_ :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 @@ -136,7 +136,7 @@ async def delete_calendar( """ Deletes a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -173,7 +173,7 @@ async def delete_calendar_event( """ Deletes scheduled events from a calendar. - ``_ + ``_ :param calendar_id: The ID of the calendar to modify :param event_id: The ID of the event to remove from the calendar @@ -213,7 +213,7 @@ async def delete_calendar_job( """ Deletes anomaly detection 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 @@ -255,7 +255,7 @@ async def delete_data_frame_analytics( """ Deletes an existing 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 @@ -299,7 +299,7 @@ async def delete_datafeed( """ Deletes an existing datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -346,7 +346,7 @@ async def delete_expired_data( """ Deletes expired and unused machine learning data. - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -397,7 +397,7 @@ async def delete_filter( """ Deletes a filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -436,7 +436,7 @@ async def delete_forecast( """ Deletes forecasts from a machine learning job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -493,7 +493,7 @@ async def delete_job( """ Deletes an existing anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param force: Use to forcefully delete an opened job; this method is quicker @@ -538,7 +538,7 @@ async def delete_model_snapshot( """ Deletes an existing model snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -579,7 +579,7 @@ async def delete_trained_model( Deletes an existing trained inference model that is currently 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 @@ -620,7 +620,7 @@ async def delete_trained_model_alias( """ Deletes a model alias that refers to the trained model - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -663,7 +663,7 @@ async def estimate_model_memory( """ Estimates the model memory - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -721,7 +721,7 @@ async def evaluate_data_frame( """ Evaluates the data frame analytics for an annotated index. - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -779,7 +779,7 @@ async def explain_data_frame_analytics( """ Explains a data frame analytics config. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -870,7 +870,7 @@ async def flush_job( """ Forces any buffered data to be processed by the job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -931,7 +931,7 @@ async def forecast( """ Predicts the future behavior of a time series by using its historical behavior. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -997,7 +997,7 @@ async def get_buckets( """ Retrieves anomaly detection job results for one or more buckets. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1084,7 +1084,7 @@ async def get_calendar_events( """ Retrieves information about the scheduled 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 @@ -1145,7 +1145,7 @@ async def get_calendars( """ Retrieves configuration information for 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 @@ -1209,7 +1209,7 @@ async def get_categories( """ Retrieves anomaly detection job results for one or more categories. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param category_id: Identifier for the category, which is unique in the job. @@ -1277,7 +1277,7 @@ async def get_data_frame_analytics( """ Retrieves configuration information for data frame analytics jobs. - ``_ + ``_ :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 @@ -1343,7 +1343,7 @@ async def get_data_frame_analytics_stats( """ Retrieves usage information for data frame analytics jobs. - ``_ + ``_ :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 @@ -1404,7 +1404,7 @@ async def get_datafeed_stats( """ Retrieves usage information for 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 @@ -1456,7 +1456,7 @@ async def get_datafeeds( """ Retrieves configuration information for 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 @@ -1515,7 +1515,7 @@ async def get_filters( """ Retrieves filters. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1570,7 +1570,7 @@ async def get_influencers( """ Retrieves anomaly detection job results for one or more influencers. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -1644,7 +1644,7 @@ async def get_job_stats( """ Retrieves usage information for anomaly detection jobs. - ``_ + ``_ :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 @@ -1697,7 +1697,7 @@ async def get_jobs( """ Retrieves configuration information for anomaly detection jobs. - ``_ + ``_ :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 @@ -1754,7 +1754,7 @@ async def get_memory_stats( """ Returns information on how ML is using memory. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -1803,7 +1803,7 @@ async def get_model_snapshot_upgrade_stats( """ Gets stats for anomaly detection job model snapshot upgrades that are in progress. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -1866,7 +1866,7 @@ async def get_model_snapshots( """ Retrieves information about model snapshots. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -1948,7 +1948,7 @@ async def get_overall_buckets( Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. - ``_ + ``_ :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. @@ -2028,7 +2028,7 @@ async def get_records( """ Retrieves anomaly records for an anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2111,7 +2111,7 @@ async def get_trained_models( """ Retrieves configuration information for a trained inference model. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param allow_no_match: Specifies what to do when the request: - Contains wildcard @@ -2187,7 +2187,7 @@ async def get_trained_models_stats( """ Retrieves usage information for trained inference models. - ``_ + ``_ :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. @@ -2245,7 +2245,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 @@ -2296,7 +2296,7 @@ async def info( """ Returns defaults and limits used by machine learning. - ``_ + ``_ """ __path = "/_ml/info" __query: t.Dict[str, t.Any] = {} @@ -2331,7 +2331,7 @@ async def open_job( """ Opens one or more anomaly detection jobs. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2380,7 +2380,7 @@ async def post_calendar_events( """ Posts scheduled events in a 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 @@ -2429,7 +2429,7 @@ async def post_data( """ Sends data to an anomaly detection job for analysis. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -2482,7 +2482,7 @@ async def preview_data_frame_analytics( """ Previews that will be analyzed given 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 @@ -2533,7 +2533,7 @@ async def preview_datafeed( """ Previews a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -2594,7 +2594,7 @@ async def put_calendar( """ Instantiates a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -2642,7 +2642,7 @@ async def put_calendar_job( """ Adds an anomaly detection job to 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 @@ -2697,7 +2697,7 @@ async def put_data_frame_analytics( """ Instantiates 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. @@ -2858,7 +2858,7 @@ async def put_datafeed( """ Instantiates a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3004,7 +3004,7 @@ async def put_filter( """ Instantiates a filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3067,7 +3067,7 @@ async def put_job( """ Instantiates an anomaly detection job. - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -3225,7 +3225,7 @@ async def put_trained_model( """ Creates an inference trained model. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param inference_config: The default configuration for inference. This can be @@ -3308,7 +3308,7 @@ async def put_trained_model_alias( Creates a new model alias (or reassigns an existing one) to refer to the trained model - ``_ + ``_ :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. @@ -3358,7 +3358,7 @@ async def put_trained_model_definition_part( """ Creates 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 @@ -3424,7 +3424,7 @@ async def put_trained_model_vocabulary( """ Creates a trained model vocabulary - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -3470,7 +3470,7 @@ async def reset_job( """ Resets an existing anomaly detection job. - ``_ + ``_ :param job_id: The ID of the job to reset. :param wait_for_completion: Should this request wait until the operation has @@ -3514,7 +3514,7 @@ async def revert_model_snapshot( """ Reverts to a specific snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -3566,7 +3566,7 @@ async def set_upgrade_mode( Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -3608,7 +3608,7 @@ async def start_data_frame_analytics( """ Starts 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. @@ -3655,7 +3655,7 @@ async def start_datafeed( """ Starts one or more datafeeds. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3716,7 +3716,7 @@ async def start_trained_model_deployment( """ Start a trained model deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -3789,7 +3789,7 @@ async def stop_data_frame_analytics( """ Stops one or more data frame analytics jobs. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3849,7 +3849,7 @@ async def stop_datafeed( """ Stops one or more datafeeds. - ``_ + ``_ :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 @@ -3905,7 +3905,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 @@ -3960,7 +3960,7 @@ async def update_data_frame_analytics( """ Updates certain properties of 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. @@ -4055,7 +4055,7 @@ async def update_datafeed( """ Updates certain properties of a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4208,7 +4208,7 @@ async def update_filter( """ Updates the description of a filter, adds items, or removes items. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -4276,7 +4276,7 @@ async def update_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 @@ -4394,7 +4394,7 @@ async def update_model_snapshot( """ Updates certain properties of a snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -4445,7 +4445,7 @@ async def upgrade_job_snapshot( """ Upgrades a given job snapshot to the current major version. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -4503,7 +4503,7 @@ async def validate( """ Validates an anomaly detection job. - ``_ + ``_ :param analysis_config: :param analysis_limits: @@ -4566,7 +4566,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 3fd1425ad..a410f19a8 100644 --- a/elasticsearch/_async/client/monitoring.py +++ b/elasticsearch/_async/client/monitoring.py @@ -46,7 +46,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 9f0272e99..32f7ff74c 100644 --- a/elasticsearch/_async/client/nodes.py +++ b/elasticsearch/_async/client/nodes.py @@ -40,7 +40,7 @@ async def clear_repositories_metering_archive( """ Removes the archived repositories metering information present 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). @@ -81,7 +81,7 @@ async def get_repositories_metering_info( """ Returns cluster repositories metering information. - ``_ + ``_ :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). @@ -134,7 +134,7 @@ async def hot_threads( """ Returns information about hot threads on each node in the cluster. - ``_ + ``_ :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 @@ -209,7 +209,7 @@ async def info( """ Returns information about nodes in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -271,7 +271,7 @@ async def reload_secure_settings( """ Reloads secure settings. - ``_ + ``_ :param node_id: A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. @@ -348,7 +348,7 @@ async def stats( """ Returns statistical information about nodes in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -450,7 +450,7 @@ async def usage( """ Returns low-level information about REST actions usage on nodes. - ``_ + ``_ :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/rollup.py b/elasticsearch/_async/client/rollup.py index 3c1a4d74a..c09183469 100644 --- a/elasticsearch/_async/client/rollup.py +++ b/elasticsearch/_async/client/rollup.py @@ -39,7 +39,7 @@ async def delete_job( """ Deletes an existing rollup job. - ``_ + ``_ :param id: The ID of the job to delete """ @@ -75,7 +75,7 @@ async def get_jobs( """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :param id: The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs @@ -114,7 +114,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: The ID of the index to check rollup capabilities on, or left blank for all jobs @@ -153,7 +153,7 @@ async def get_rollup_index_caps( Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). - ``_ + ``_ :param index: The rollup index or index pattern to obtain rollup capabilities from. @@ -205,7 +205,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. @@ -314,7 +314,7 @@ async def rollup_search( """ Enables searching rolled-up data using the standard query DSL. - ``_ + ``_ :param index: The indices or index-pattern(s) (containing rollup or regular data) that should be searched @@ -372,7 +372,7 @@ async def start_job( """ Starts an existing, stopped rollup job. - ``_ + ``_ :param id: The ID of the job to start """ @@ -410,7 +410,7 @@ async def stop_job( """ Stops an existing, started rollup job. - ``_ + ``_ :param id: The ID of the job to stop :param timeout: Block for (at maximum) the specified duration while waiting for diff --git a/elasticsearch/_async/client/searchable_snapshots.py b/elasticsearch/_async/client/searchable_snapshots.py index 5bce0114c..51cca4b84 100644 --- a/elasticsearch/_async/client/searchable_snapshots.py +++ b/elasticsearch/_async/client/searchable_snapshots.py @@ -44,7 +44,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 @@ -106,7 +106,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 @@ -170,7 +170,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 @@ -239,7 +239,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 b983651b7..8e0a099cf 100644 --- a/elasticsearch/_async/client/security.py +++ b/elasticsearch/_async/client/security.py @@ -44,7 +44,7 @@ async def activate_user_profile( """ Creates or updates the user profile on behalf of another user. - ``_ + ``_ :param grant_type: :param access_token: @@ -92,7 +92,7 @@ async def authenticate( Enables authentication as a user and retrieve information about the authenticated user. - ``_ + ``_ """ __path = "/_security/_authenticate" __query: t.Dict[str, t.Any] = {} @@ -131,7 +131,7 @@ async def change_password( """ Changes 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. @@ -185,7 +185,7 @@ async def clear_api_key_cache( """ Clear a subset or all entries from the API key cache. - ``_ + ``_ :param ids: A comma-separated list of IDs of API keys to clear from the cache """ @@ -221,7 +221,7 @@ async def clear_cached_privileges( """ Evicts application privileges from the native application privileges cache. - ``_ + ``_ :param application: A comma-separated list of application names """ @@ -259,7 +259,7 @@ async def clear_cached_realms( Evicts users from the user cache. 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 @@ -298,7 +298,7 @@ async def clear_cached_roles( """ Evicts roles from the native role cache. - ``_ + ``_ :param name: Role name """ @@ -336,7 +336,7 @@ async def clear_cached_service_tokens( """ Evicts tokens from the service account token caches. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -386,7 +386,7 @@ async def create_api_key( """ Creates an API key for access without requiring basic authentication. - ``_ + ``_ :param expiration: Expiration time for the API key. By default, API keys never expire. @@ -452,7 +452,7 @@ async def create_service_token( """ Creates a service account token for access without requiring basic authentication. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -512,7 +512,7 @@ async def delete_privileges( """ Removes application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -559,7 +559,7 @@ async def delete_role( """ Removes roles in the native realm. - ``_ + ``_ :param name: Role name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -603,7 +603,7 @@ async def delete_role_mapping( """ Removes role mappings. - ``_ + ``_ :param name: Role-mapping name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -649,7 +649,7 @@ async def delete_service_token( """ Deletes a service account token. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -699,7 +699,7 @@ async def delete_user( """ Deletes users from the native realm. - ``_ + ``_ :param username: username :param refresh: If `true` (the default) then refresh the affected shards to make @@ -743,7 +743,7 @@ async def disable_user( """ Disables 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 @@ -787,7 +787,7 @@ async def disable_user_profile( """ Disables a user profile so it's 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 @@ -831,7 +831,7 @@ async def enable_user( """ Enables 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 @@ -875,7 +875,7 @@ async def enable_user_profile( """ Enables a user profile so it's visible in user profile searches. - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -916,7 +916,7 @@ async def enroll_kibana( Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. - ``_ + ``_ """ __path = "/_security/enroll/kibana" __query: t.Dict[str, t.Any] = {} @@ -947,7 +947,7 @@ async def enroll_node( """ Allows a new node to enroll to an existing cluster with security enabled. - ``_ + ``_ """ __path = "/_security/enroll/node" __query: t.Dict[str, t.Any] = {} @@ -984,7 +984,7 @@ async def get_api_key( """ Retrieves information for one or more API keys. - ``_ + ``_ :param id: API key id of the API key to be retrieved :param name: API key name of the API key to be retrieved @@ -1037,7 +1037,7 @@ async def get_builtin_privileges( Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ __path = "/_security/privilege/_builtin" __query: t.Dict[str, t.Any] = {} @@ -1070,7 +1070,7 @@ async def get_privileges( """ Retrieves application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -1110,7 +1110,7 @@ async def get_role( """ Retrieves roles in the native realm. - ``_ + ``_ :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 @@ -1149,7 +1149,7 @@ async def get_role_mapping( """ Retrieves role mappings. - ``_ + ``_ :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 @@ -1191,7 +1191,7 @@ async def get_service_accounts( """ Retrieves information about service accounts. - ``_ + ``_ :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 @@ -1235,7 +1235,7 @@ async def get_service_credentials( """ Retrieves information of all service credentials for a service account. - ``_ + ``_ :param namespace: Name of the namespace. :param service: Name of the service name. @@ -1286,7 +1286,7 @@ async def get_token( """ Creates a bearer token for access without requiring basic authentication. - ``_ + ``_ :param grant_type: :param kerberos_ticket: @@ -1341,7 +1341,7 @@ async def get_user( """ Retrieves 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 @@ -1386,7 +1386,7 @@ async def get_user_privileges( """ Retrieves security privileges for the logged in user. - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -1432,7 +1432,7 @@ async def get_user_profile( """ Retrieves user profiles for the given unique ID(s). - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: List of filters for the `data` field of the profile document. To @@ -1482,7 +1482,7 @@ async def grant_api_key( """ Creates an API key on behalf of another user. - ``_ + ``_ :param api_key: :param grant_type: @@ -1563,7 +1563,7 @@ async def has_privileges( """ Determines whether the specified user has a specified list of privileges. - ``_ + ``_ :param user: Username :param application: @@ -1614,7 +1614,7 @@ async def has_privileges_user_profile( Determines whether the users associated with the specified profile IDs have all the requested privileges. - ``_ + ``_ :param privileges: :param uids: A list of profile IDs. The privileges are checked for associated @@ -1666,7 +1666,7 @@ async def invalidate_api_key( """ Invalidates one or more API keys. - ``_ + ``_ :param id: :param ids: @@ -1723,7 +1723,7 @@ async def invalidate_token( """ Invalidates one or more access tokens or refresh tokens. - ``_ + ``_ :param realm_name: :param refresh_token: @@ -1774,7 +1774,7 @@ async def put_privileges( """ Adds or updates application privileges. - ``_ + ``_ :param privileges: :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1849,7 +1849,7 @@ async def put_role( """ Adds and updates roles in the native realm. - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -1931,7 +1931,7 @@ async def put_role_mapping( """ Creates and updates role mappings. - ``_ + ``_ :param name: Role-mapping name :param enabled: @@ -2001,7 +2001,7 @@ async def put_user( Adds and updates users in the native realm. These users are commonly referred to as native users. - ``_ + ``_ :param username: The username of the User :param email: @@ -2085,7 +2085,7 @@ async def query_api_keys( """ Retrieves information for API keys using a subset of query DSL - ``_ + ``_ :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 @@ -2166,7 +2166,7 @@ async def saml_authenticate( Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair - ``_ + ``_ :param content: The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document. @@ -2221,7 +2221,7 @@ async def saml_complete_logout( """ 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. @@ -2280,7 +2280,7 @@ async def saml_invalidate( """ Consumes a SAML LogoutRequest - ``_ + ``_ :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 @@ -2341,7 +2341,7 @@ async def saml_logout( Invalidates an access token and a refresh token that were generated via the SAML Authenticate API - ``_ + ``_ :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 @@ -2391,7 +2391,7 @@ async def saml_prepare_authentication( """ Creates a SAML authentication request - ``_ + ``_ :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 @@ -2440,7 +2440,7 @@ async def saml_service_provider_metadata( """ Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -2481,7 +2481,7 @@ async def suggest_user_profiles( """ 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=` @@ -2542,7 +2542,7 @@ async def update_api_key( """ Updates attributes of an existing API key. - ``_ + ``_ :param id: The ID of the API key to update. :param metadata: Arbitrary metadata that you want to associate with the API key. @@ -2607,7 +2607,7 @@ async def update_user_profile_data( """ Update application specific data for the user profile of the given 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 438ac239f..adf205461 100644 --- a/elasticsearch/_async/client/slm.py +++ b/elasticsearch/_async/client/slm.py @@ -39,7 +39,7 @@ async def delete_lifecycle( """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove """ @@ -76,7 +76,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 """ @@ -111,7 +111,7 @@ async def execute_retention( """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ __path = "/_slm/_execute_retention" __query: t.Dict[str, t.Any] = {} @@ -146,7 +146,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 """ @@ -183,7 +183,7 @@ async def get_stats( Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ __path = "/_slm/stats" __query: t.Dict[str, t.Any] = {} @@ -214,7 +214,7 @@ async def get_status( """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ __path = "/_slm/status" __query: t.Dict[str, t.Any] = {} @@ -257,7 +257,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. @@ -328,7 +328,7 @@ async def start( """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ __path = "/_slm/start" __query: t.Dict[str, t.Any] = {} @@ -359,7 +359,7 @@ async def stop( """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ __path = "/_slm/stop" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_async/client/snapshot.py b/elasticsearch/_async/client/snapshot.py index dcee0c90a..3c884055d 100644 --- a/elasticsearch/_async/client/snapshot.py +++ b/elasticsearch/_async/client/snapshot.py @@ -43,7 +43,7 @@ async def cleanup_repository( """ Removes stale data from repository. - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -94,7 +94,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 @@ -163,7 +163,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. @@ -261,7 +261,7 @@ async def create_repository( """ Creates a repository. - ``_ + ``_ :param name: A repository name :param settings: @@ -324,7 +324,7 @@ async def delete( """ Deletes one or more snapshots. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -370,7 +370,7 @@ async def delete_repository( """ Deletes a repository. - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -434,7 +434,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. @@ -541,7 +541,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 @@ -605,7 +605,7 @@ async def restore( """ Restores a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -690,7 +690,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 @@ -741,7 +741,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 57b2850eb..09198d568 100644 --- a/elasticsearch/_async/client/sql.py +++ b/elasticsearch/_async/client/sql.py @@ -41,7 +41,7 @@ async def clear_cursor( """ Clears the SQL cursor - ``_ + ``_ :param cursor: """ @@ -81,7 +81,7 @@ async def delete_async( Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. - ``_ + ``_ :param id: The async search ID """ @@ -124,7 +124,7 @@ async def get_async( Returns the current status and available results for an async SQL search or stored synchronous SQL search - ``_ + ``_ :param id: The async search ID :param delimiter: Separator for CSV results. The API only supports this parameter @@ -178,7 +178,7 @@ async def get_async_status( Returns the current status of an async SQL search or a stored synchronous SQL search - ``_ + ``_ :param id: The async search ID """ @@ -237,7 +237,7 @@ async def query( """ Executes a SQL request - ``_ + ``_ :param catalog: Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. @@ -338,7 +338,7 @@ async def translate( """ Translates SQL into Elasticsearch queries - ``_ + ``_ :param query: :param fetch_size: diff --git a/elasticsearch/_async/client/ssl.py b/elasticsearch/_async/client/ssl.py index e3fb585f1..0340404b1 100644 --- a/elasticsearch/_async/client/ssl.py +++ b/elasticsearch/_async/client/ssl.py @@ -39,7 +39,7 @@ async def certificates( Retrieves information about the X.509 certificates used to encrypt communications in the cluster. - ``_ + ``_ """ __path = "/_ssl/certificates" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_async/client/tasks.py b/elasticsearch/_async/client/tasks.py index fc75f5b0c..05c2e2f27 100644 --- a/elasticsearch/_async/client/tasks.py +++ b/elasticsearch/_async/client/tasks.py @@ -45,7 +45,7 @@ async def cancel( """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :param task_id: Cancel the task with specified task id (node_id:task_number) :param actions: A comma-separated list of actions that should be cancelled. Leave @@ -101,7 +101,7 @@ async def get( """ Returns information about a task. - ``_ + ``_ :param task_id: Return the task with specified id (node_id:task_number) :param timeout: Explicit operation timeout @@ -157,7 +157,7 @@ async def list( """ Returns a list of tasks. - ``_ + ``_ :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 a4c2349b1..3812648a2 100644 --- a/elasticsearch/_async/client/text_structure.py +++ b/elasticsearch/_async/client/text_structure.py @@ -50,7 +50,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 diff --git a/elasticsearch/_async/client/transform.py b/elasticsearch/_async/client/transform.py index c0eef7047..32cc50b77 100644 --- a/elasticsearch/_async/client/transform.py +++ b/elasticsearch/_async/client/transform.py @@ -41,7 +41,7 @@ async def delete_transform( """ Deletes an existing transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param force: If this value is false, the transform must be stopped before it @@ -94,7 +94,7 @@ async def get_transform( """ 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 @@ -156,7 +156,7 @@ async def 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 @@ -219,7 +219,7 @@ async def preview_transform( """ Previews a transform. - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -316,7 +316,7 @@ async def put_transform( """ Instantiates a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -410,7 +410,7 @@ async def reset_transform( """ Resets an existing transform. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -454,7 +454,7 @@ async def start_transform( """ Starts one or more transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Period to wait for a response. If no response is received before @@ -499,7 +499,7 @@ async def stop_transform( """ 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, @@ -578,7 +578,7 @@ async def update_transform( """ Updates certain properties of a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param defer_validation: When true, deferrable validations are not run. This @@ -653,7 +653,7 @@ async def upgrade_transforms( """ Upgrades all transforms. - ``_ + ``_ :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 decb2e5a6..acd019f94 100644 --- a/elasticsearch/_async/client/watcher.py +++ b/elasticsearch/_async/client/watcher.py @@ -42,7 +42,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 @@ -84,7 +84,7 @@ async def activate_watch( """ Activates a currently inactive watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -120,7 +120,7 @@ async def deactivate_watch( """ Deactivates a currently active watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -156,7 +156,7 @@ async def delete_watch( """ Removes a watch from Watcher. - ``_ + ``_ :param id: Watch ID """ @@ -210,7 +210,7 @@ async def execute_watch( """ Forces the execution of a stored watch. - ``_ + ``_ :param id: Identifier for the watch. :param action_modes: Determines how to handle the watch actions as part of the @@ -285,7 +285,7 @@ async def get_watch( """ Retrieves a watch by its ID. - ``_ + ``_ :param id: Watch ID """ @@ -334,7 +334,7 @@ async def put_watch( """ Creates a new watch, or updates an existing one. - ``_ + ``_ :param id: Watch ID :param actions: @@ -430,7 +430,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. @@ -494,7 +494,7 @@ async def start( """ Starts Watcher if it is not already running. - ``_ + ``_ """ __path = "/_watcher/_start" __query: t.Dict[str, t.Any] = {} @@ -549,7 +549,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 @@ -589,7 +589,7 @@ async def stop( """ Stops Watcher if it is running. - ``_ + ``_ """ __path = "/_watcher/_stop" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_async/client/xpack.py b/elasticsearch/_async/client/xpack.py index 5e121da13..b227d45be 100644 --- a/elasticsearch/_async/client/xpack.py +++ b/elasticsearch/_async/client/xpack.py @@ -45,7 +45,7 @@ async def info( """ Retrieves 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 @@ -87,7 +87,7 @@ async def usage( """ Retrieves usage information about the installed X-Pack features. - ``_ + ``_ :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 8d73f962b..c82c73d01 100644 --- a/elasticsearch/_sync/client/__init__.py +++ b/elasticsearch/_sync/client/__init__.py @@ -638,7 +638,7 @@ def bulk( """ Allows to perform multiple index/update/delete operations in a single request. - ``_ + ``_ :param operations: :param index: Default index for items which don't provide one @@ -723,7 +723,7 @@ def clear_scroll( """ Explicitly clears the search context for a scroll. - ``_ + ``_ :param scroll_id: """ @@ -766,7 +766,7 @@ def close_point_in_time( """ Close a point in time - ``_ + ``_ :param id: """ @@ -843,7 +843,7 @@ def count( """ Returns number of documents matching a query. - ``_ + ``_ :param index: A comma-separated list of indices to restrict the results :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -960,7 +960,7 @@ def create( Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -1045,7 +1045,7 @@ def delete( """ Removes a document from the index. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1173,7 +1173,7 @@ def delete_by_query( """ Deletes documents matching the provided query. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -1337,7 +1337,7 @@ def delete_by_query_rethrottle( """ Changes the number of requests per second for a particular Delete By Query operation. - ``_ + ``_ :param task_id: The task id to rethrottle :param requests_per_second: The throttle to set on this request in floating sub-requests @@ -1381,7 +1381,7 @@ def delete_script( """ Deletes a script. - ``_ + ``_ :param id: Script ID :param master_timeout: Specify timeout for connection to master @@ -1450,7 +1450,7 @@ def exists( """ Returns information about whether a document exists in an index. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1550,7 +1550,7 @@ def exists_source( """ Returns information about whether a document source exists in an index. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1651,7 +1651,7 @@ def explain( """ Returns information about why a specific matches (or doesn't match) a query. - ``_ + ``_ :param index: The name of the index :param id: The document ID @@ -1772,7 +1772,7 @@ def field_caps( """ Returns the information about the capabilities of fields among multiple indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -1884,7 +1884,7 @@ def get( """ Returns a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -1964,7 +1964,7 @@ def get_script( """ Returns a script. - ``_ + ``_ :param id: Script ID :param master_timeout: Specify timeout for connection to master @@ -2002,7 +2002,7 @@ def get_script_context( """ Returns all script contexts. - ``_ + ``_ """ __path = "/_script_context" __query: t.Dict[str, t.Any] = {} @@ -2033,7 +2033,7 @@ def get_script_languages( """ Returns available script types, languages and contexts - ``_ + ``_ """ __path = "/_script_language" __query: t.Dict[str, t.Any] = {} @@ -2092,7 +2092,7 @@ def get_source( """ Returns the source of a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2189,7 +2189,7 @@ def index( """ Creates or updates a document in an index. - ``_ + ``_ :param index: The name of the index :param document: @@ -2280,7 +2280,7 @@ def info( """ Returns basic information about the cluster. - ``_ + ``_ """ __path = "/" __query: t.Dict[str, t.Any] = {} @@ -2335,7 +2335,7 @@ def knn_search( """ Performs a kNN search. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or to perform the operation on all indices @@ -2438,7 +2438,7 @@ def mget( """ Allows to get multiple documents in one request. - ``_ + ``_ :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. @@ -2555,7 +2555,7 @@ def msearch( """ Allows to execute several search operations in one request. - ``_ + ``_ :param searches: :param index: Comma-separated list of data streams, indices, and index aliases @@ -2668,7 +2668,7 @@ def msearch_template( """ Allows to execute several search template operations in one request. - ``_ + ``_ :param search_templates: :param index: A comma-separated list of index names to use as default @@ -2752,7 +2752,7 @@ def mtermvectors( """ Returns multiple termvectors in one request. - ``_ + ``_ :param index: The index in which the document resides. :param docs: @@ -2847,7 +2847,7 @@ def open_point_in_time( """ Open a point in time that can be used in subsequent searches - ``_ + ``_ :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 @@ -2901,7 +2901,7 @@ def put_script( """ Creates or updates a script. - ``_ + ``_ :param id: Script ID :param script: @@ -2983,7 +2983,7 @@ def rank_eval( Allows to 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. @@ -3070,7 +3070,7 @@ def reindex( source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. - ``_ + ``_ :param dest: :param source: @@ -3159,7 +3159,7 @@ def reindex_rethrottle( """ Changes the number of requests per second for a particular Reindex operation. - ``_ + ``_ :param task_id: The task id to rethrottle :param requests_per_second: The throttle to set on this request in floating sub-requests @@ -3205,7 +3205,7 @@ def render_search_template( """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :param id: The id of the stored search template :param file: @@ -3260,7 +3260,7 @@ def scripts_painless_execute( """ Allows an arbitrary script to be executed and a result to be returned - ``_ + ``_ :param context: :param context_setup: @@ -3311,7 +3311,7 @@ def scroll( """ Allows to retrieve a large numbers of results from a single search request. - ``_ + ``_ :param scroll_id: Scroll ID of the search. :param rest_total_hits_as_int: If true, the API response’s hit.total property @@ -3485,7 +3485,7 @@ def search( """ Returns results matching a query. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -3814,7 +3814,7 @@ def search_mvt( Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, or aliases to search :param field: Field containing geospatial data to return @@ -3955,7 +3955,7 @@ def search_shards( Returns information about the indices and shards that a search request would be executed against. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -4055,7 +4055,7 @@ def search_template( """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). @@ -4166,7 +4166,7 @@ def terms_enum( the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported. @@ -4260,7 +4260,7 @@ def termvectors( Returns information and statistics about terms in the fields of a particular document. - ``_ + ``_ :param index: The index in which the document resides. :param id: The id of the document, when not specified a doc param should be supplied. @@ -4387,7 +4387,7 @@ def update( """ Updates a document with a script or partial document. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -4556,7 +4556,7 @@ def update_by_query( Performs an update on every document in the index without changing the source, for example to pick up a mapping change. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -4732,7 +4732,7 @@ def update_by_query_rethrottle( """ Changes the number of requests per second for a particular Update By Query operation. - ``_ + ``_ :param task_id: The task id to rethrottle :param requests_per_second: The throttle to set on this request in floating sub-requests diff --git a/elasticsearch/_sync/client/async_search.py b/elasticsearch/_sync/client/async_search.py index 959cf81dc..175bf0b6d 100644 --- a/elasticsearch/_sync/client/async_search.py +++ b/elasticsearch/_sync/client/async_search.py @@ -40,7 +40,7 @@ def delete( Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :param id: The async search ID """ @@ -82,7 +82,7 @@ def get( Retrieves the results of a previously submitted async search request given its ID. - ``_ + ``_ :param id: The async search ID :param keep_alive: Specify the time interval in which the results (partial or @@ -131,7 +131,7 @@ def status( Retrieves the status of a previously submitted async search request given its ID. - ``_ + ``_ :param id: The async search ID """ @@ -295,7 +295,7 @@ def submit( """ Executes a search request asynchronously. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_sync/client/autoscaling.py b/elasticsearch/_sync/client/autoscaling.py index bf78751a8..19bc26654 100644 --- a/elasticsearch/_sync/client/autoscaling.py +++ b/elasticsearch/_sync/client/autoscaling.py @@ -40,7 +40,7 @@ def delete_autoscaling_policy( Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ :param name: the name of the autoscaling policy """ @@ -76,7 +76,7 @@ def get_autoscaling_capacity( Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ """ __path = "/_autoscaling/capacity" __query: t.Dict[str, t.Any] = {} @@ -109,7 +109,7 @@ def get_autoscaling_policy( Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ :param name: the name of the autoscaling policy """ @@ -149,7 +149,7 @@ def put_autoscaling_policy( Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - ``_ + ``_ :param name: the name of the autoscaling policy :param policy: diff --git a/elasticsearch/_sync/client/cat.py b/elasticsearch/_sync/client/cat.py index 570be9ee5..7ba6abd8b 100644 --- a/elasticsearch/_sync/client/cat.py +++ b/elasticsearch/_sync/client/cat.py @@ -67,7 +67,7 @@ def aliases( Shows information about currently configured aliases to indices including filter and routing infos. - ``_ + ``_ :param name: A comma-separated list of alias names to return :param expand_wildcards: Whether to expand wildcard expression to concrete indices @@ -151,7 +151,7 @@ def allocation( Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information @@ -229,7 +229,7 @@ def component_templates( """ Returns information about existing component_templates templates. - ``_ + ``_ :param name: A pattern that returned component template names must match :param format: Specifies the format to return the columnar data in, can be set @@ -304,7 +304,7 @@ def count( Provides quick access to the document count of the entire cluster, or individual indices. - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param format: Specifies the format to return the columnar data in, can be set @@ -384,7 +384,7 @@ def fielddata( Shows how much heap memory is currently being used by fielddata on every data node in the cluster. - ``_ + ``_ :param fields: A comma-separated list of fields to return the fielddata size :param bytes: The unit in which to display byte values @@ -461,7 +461,7 @@ def health( """ Returns a concise representation of the cluster health. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -533,7 +533,7 @@ def 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`. @@ -622,13 +622,16 @@ def indices( pretty: t.Optional[bool] = None, pri: t.Optional[bool] = None, s: t.Optional[t.Union[str, t.Union[t.List[str], t.Tuple[str, ...]]]] = None, + time: t.Optional[ + t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str] + ] = None, v: t.Optional[bool] = None, ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]: """ Returns information about indices: number of primaries and replicas, document counts, disk size, ... - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param bytes: The unit in which to display byte values @@ -652,6 +655,7 @@ def indices( :param s: List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. + :param time: The unit in which to display time values :param v: When set to `true` will enable verbose output. """ if index not in SKIP_IN_PATH: @@ -689,6 +693,8 @@ def indices( __query["pri"] = pri if s is not None: __query["s"] = s + if time is not None: + __query["time"] = time if v is not None: __query["v"] = v __headers = {"accept": "text/plain,application/json"} @@ -719,7 +725,7 @@ def master( """ Returns information about the master node. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -838,7 +844,7 @@ def ml_data_frame_analytics( """ Gets configuration and usage information about data frame analytics jobs. - ``_ + ``_ :param id: The ID of the data frame analytics to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -969,7 +975,7 @@ def ml_datafeeds( """ Gets configuration and usage information about datafeeds. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1106,7 +1112,7 @@ def ml_jobs( """ Gets configuration and usage information about anomaly detection jobs. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param allow_no_match: Specifies what to do when the request: * Contains wildcard @@ -1246,7 +1252,7 @@ def ml_trained_models( """ Gets configuration and usage information about inference trained models. - ``_ + ``_ :param model_id: The ID of the trained models stats to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -1331,7 +1337,7 @@ def nodeattrs( """ Returns information about custom node attributes. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1404,7 +1410,7 @@ def nodes( """ Returns basic statistics about performance of cluster nodes. - ``_ + ``_ :param bytes: The unit in which to display byte values :param format: Specifies the format to return the columnar data in, can be set @@ -1480,7 +1486,7 @@ def pending_tasks( """ Returns a concise representation of the cluster pending tasks. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1549,7 +1555,7 @@ def plugins( """ Returns information about installed plugins across nodes node. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1624,7 +1630,7 @@ def recovery( """ Returns information about index shard recoveries, both on-going completed. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names to limit the returned information @@ -1708,7 +1714,7 @@ def repositories( """ Returns information about snapshot repositories registered in the cluster. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1781,7 +1787,7 @@ def segments( """ Provides low-level information about the segments in the shards of an index. - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param bytes: The unit in which to display byte values @@ -1861,7 +1867,7 @@ def shards( """ Provides a detailed view of shard allocation on nodes. - ``_ + ``_ :param index: A comma-separated list of index names to limit the returned information :param bytes: The unit in which to display byte values @@ -1941,7 +1947,7 @@ def snapshots( """ Returns all snapshots in a specific repository. - ``_ + ``_ :param repository: Name of repository from which to fetch the snapshot information :param format: Specifies the format to return the columnar data in, can be set @@ -2022,7 +2028,7 @@ def tasks( Returns information about the tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :param actions: A comma-separated list of actions that should be returned. Leave empty to return all. @@ -2105,7 +2111,7 @@ def templates( """ Returns information about existing templates. - ``_ + ``_ :param name: A pattern that returned template names must match :param format: Specifies the format to return the columnar data in, can be set @@ -2185,7 +2191,7 @@ def thread_pool( Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. - ``_ + ``_ :param thread_pool_patterns: List of thread pool names used to limit the request. Accepts wildcard expressions. @@ -2315,7 +2321,7 @@ def transforms( """ Gets configuration and usage information about transforms. - ``_ + ``_ :param transform_id: The id of the transform for which to get stats. '_all' or '*' implies all transforms diff --git a/elasticsearch/_sync/client/ccr.py b/elasticsearch/_sync/client/ccr.py index 300bf5fb2..d6161e7c6 100644 --- a/elasticsearch/_sync/client/ccr.py +++ b/elasticsearch/_sync/client/ccr.py @@ -39,7 +39,7 @@ def delete_auto_follow_pattern( """ Deletes auto-follow patterns. - ``_ + ``_ :param name: The name of the auto follow pattern. """ @@ -96,7 +96,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: @@ -180,7 +180,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 @@ -218,7 +218,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 @@ -261,7 +261,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 @@ -312,7 +312,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. @@ -350,7 +350,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. @@ -388,7 +388,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. @@ -452,7 +452,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 @@ -566,7 +566,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. @@ -619,7 +619,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: @@ -693,7 +693,7 @@ def stats( """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ __path = "/_ccr/stats" __query: t.Dict[str, t.Any] = {} @@ -726,7 +726,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 9f1c9db43..cb1b3a8fe 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. @@ -111,7 +111,7 @@ def delete_component_template( """ Deletes a component template - ``_ + ``_ :param name: Comma-separated list or wildcard expression of component template names used to limit the request. @@ -154,7 +154,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 @@ -199,7 +199,7 @@ def exists_component_template( """ Returns information about whether a particular component template exist - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported. @@ -251,7 +251,7 @@ def get_component_template( """ Returns one or more component templates - ``_ + ``_ :param name: The comma separated names of the component templates :param flat_settings: @@ -303,7 +303,7 @@ def get_settings( """ Returns cluster settings. - ``_ + ``_ :param flat_settings: Return settings in flat format (default: false) :param include_defaults: Whether to return all default clusters setting. @@ -389,7 +389,7 @@ def health( """ Returns basic information about the health of the cluster. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target @@ -484,7 +484,7 @@ def pending_tasks( Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. - ``_ + ``_ :param local: Return local information, do not retrieve the state from master node (default: false) @@ -530,7 +530,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 @@ -591,7 +591,7 @@ def put_component_template( """ Creates or updates a component template - ``_ + ``_ :param name: The name of the template :param template: @@ -663,7 +663,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 @@ -711,7 +711,7 @@ def remote_info( """ Returns the information about configured remote clusters. - ``_ + ``_ """ __path = "/_remote/info" __query: t.Dict[str, t.Any] = {} @@ -757,7 +757,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 @@ -854,7 +854,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 @@ -932,7 +932,7 @@ def stats( """ Returns high-level overview of cluster statistics. - ``_ + ``_ :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/dangling_indices.py b/elasticsearch/_sync/client/dangling_indices.py index 9ae7146bd..5d59c6b70 100644 --- a/elasticsearch/_sync/client/dangling_indices.py +++ b/elasticsearch/_sync/client/dangling_indices.py @@ -44,7 +44,7 @@ def delete_dangling_index( """ Deletes the specified dangling index - ``_ + ``_ :param index_uuid: The UUID of the dangling index :param accept_data_loss: Must be set to true in order to delete the dangling @@ -97,7 +97,7 @@ def import_dangling_index( """ Imports the specified dangling index - ``_ + ``_ :param index_uuid: The UUID of the dangling index :param accept_data_loss: Must be set to true in order to import the dangling @@ -144,7 +144,7 @@ def list_dangling_indices( """ Returns all dangling indices. - ``_ + ``_ """ __path = "/_dangling" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_sync/client/enrich.py b/elasticsearch/_sync/client/enrich.py index 0702daa0d..0a4cf45e9 100644 --- a/elasticsearch/_sync/client/enrich.py +++ b/elasticsearch/_sync/client/enrich.py @@ -39,7 +39,7 @@ def delete_policy( """ Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :param name: The name of the enrich policy """ @@ -76,7 +76,7 @@ def execute_policy( """ Creates the enrich index for an existing enrich policy. - ``_ + ``_ :param name: The name of the enrich policy :param wait_for_completion: Should the request should block until the execution @@ -116,7 +116,7 @@ def get_policy( """ Gets information about an enrich policy. - ``_ + ``_ :param name: A comma-separated list of enrich policy names """ @@ -158,7 +158,7 @@ def put_policy( """ Creates a new enrich policy. - ``_ + ``_ :param name: The name of the enrich policy :param geo_match: @@ -204,7 +204,7 @@ def stats( Gets enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ __path = "/_enrich/_stats" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_sync/client/eql.py b/elasticsearch/_sync/client/eql.py index e299f4ec9..27e29788d 100644 --- a/elasticsearch/_sync/client/eql.py +++ b/elasticsearch/_sync/client/eql.py @@ -40,7 +40,7 @@ def delete( Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :param id: Identifier for the search to delete. """ @@ -80,7 +80,7 @@ def get( """ Returns async results from previously executed Event Query Language (EQL) search - ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -127,7 +127,7 @@ def get_status( Returns the status of a previously submitted async or stored Event Query Language (EQL) search - ``_ + ``_ :param id: Identifier for the search. """ @@ -215,7 +215,7 @@ def search( """ Returns results matching a query expressed in Event Query Language (EQL) - ``_ + ``_ :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/features.py b/elasticsearch/_sync/client/features.py index 3afabb326..ec70ea8a3 100644 --- a/elasticsearch/_sync/client/features.py +++ b/elasticsearch/_sync/client/features.py @@ -39,7 +39,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 = "/_features" __query: t.Dict[str, t.Any] = {} @@ -70,7 +70,7 @@ def reset_features( """ Resets the internal state of features, usually by deleting system indices - ``_ + ``_ """ __path = "/_features/_reset" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_sync/client/fleet.py b/elasticsearch/_sync/client/fleet.py index 65a4b7a18..ef12de0c9 100644 --- a/elasticsearch/_sync/client/fleet.py +++ b/elasticsearch/_sync/client/fleet.py @@ -44,7 +44,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 faec2c57c..18ef54e80 100644 --- a/elasticsearch/_sync/client/graph.py +++ b/elasticsearch/_sync/client/graph.py @@ -50,7 +50,7 @@ def explore( Explore extracted and summarized information about the documents and terms in an index. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_sync/client/ilm.py b/elasticsearch/_sync/client/ilm.py index fba7f8be2..abd1c27b3 100644 --- a/elasticsearch/_sync/client/ilm.py +++ b/elasticsearch/_sync/client/ilm.py @@ -44,7 +44,7 @@ def delete_lifecycle( Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -96,7 +96,7 @@ def explain_lifecycle( Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -157,7 +157,7 @@ def get_lifecycle( Returns the specified policy definition. Includes the policy version and last modified date. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -202,7 +202,7 @@ def get_status( """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ __path = "/_ilm/status" __query: t.Dict[str, t.Any] = {} @@ -239,7 +239,7 @@ def migrate_to_data_tiers( Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing - ``_ + ``_ :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 @@ -292,7 +292,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: @@ -346,7 +346,7 @@ def put_lifecycle( """ Creates a lifecycle policy - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -399,7 +399,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 """ @@ -435,7 +435,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 @@ -475,7 +475,7 @@ def start( """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ :param master_timeout: :param timeout: @@ -518,7 +518,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 8e8225a24..5c6891565 100644 --- a/elasticsearch/_sync/client/indices.py +++ b/elasticsearch/_sync/client/indices.py @@ -64,7 +64,7 @@ def add_block( """ Adds a block to an index. - ``_ + ``_ :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) @@ -144,7 +144,7 @@ def analyze( Performs the analysis process on a text and return the tokens breakdown of the text. - ``_ + ``_ :param index: The name of the index to scope the operation :param analyzer: @@ -239,7 +239,7 @@ def clear_cache( """ Clears all or specific caches for one or more indices. - ``_ + ``_ :param index: A comma-separated list of index name to limit the operation :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -314,7 +314,7 @@ def clone( """ Clones an index - ``_ + ``_ :param index: The name of the source index to clone :param target: The name of the target index to clone into @@ -401,7 +401,7 @@ def close( """ Closes an index. - ``_ + ``_ :param index: A comma separated list of indices to close :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -472,7 +472,7 @@ def create( """ Creates an index with optional settings and mappings. - ``_ + ``_ :param index: The name of the index :param aliases: @@ -533,7 +533,7 @@ def create_data_stream( """ Creates a data stream - ``_ + ``_ :param name: The name of the data stream """ @@ -587,7 +587,7 @@ def data_streams_stats( """ Provides statistics on operations happening in a data stream. - ``_ + ``_ :param name: A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams @@ -652,7 +652,7 @@ def delete( """ Deletes an index. - ``_ + ``_ :param index: A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices @@ -711,7 +711,7 @@ def delete_alias( """ Deletes an alias. - ``_ + ``_ :param index: A comma-separated list of index names (supports wildcards); use `_all` for all indices @@ -776,7 +776,7 @@ def delete_data_stream( """ Deletes a data stream. - ``_ + ``_ :param name: A comma-separated list of data streams to delete; use `*` to delete all data streams @@ -821,7 +821,7 @@ def delete_index_template( """ Deletes an index template. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -871,7 +871,7 @@ def delete_template( """ Deletes an index template. - ``_ + ``_ :param name: The name of the template :param master_timeout: Specify timeout for connection to master @@ -935,7 +935,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 @@ -1003,7 +1003,7 @@ def downsample( """ Downsample an index - ``_ + ``_ :param index: The index to downsample :param target_index: The name of the target index to store downsampled data @@ -1069,7 +1069,7 @@ def exists( """ Returns information about whether a particular index exists. - ``_ + ``_ :param index: A comma-separated list of index names :param allow_no_indices: Ignore if a wildcard expression resolves to no concrete @@ -1149,7 +1149,7 @@ def exists_alias( """ Returns information about whether a particular alias exists. - ``_ + ``_ :param name: A comma-separated list of alias names to return :param index: A comma-separated list of index names to filter aliases @@ -1211,7 +1211,7 @@ def exists_index_template( """ Returns information about whether a particular index template exists. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1258,7 +1258,7 @@ def exists_template( """ 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) @@ -1334,7 +1334,7 @@ def field_usage_stats( """ Returns the field usage stats for each field of an index - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1428,7 +1428,7 @@ def flush( """ Performs the flush operation on one or more indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string for all indices @@ -1515,7 +1515,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 @@ -1622,7 +1622,7 @@ def get( """ Returns information about one or more indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -1717,7 +1717,7 @@ def get_alias( """ Returns an alias. - ``_ + ``_ :param index: A comma-separated list of index names to filter aliases :param name: A comma-separated list of alias names to return @@ -1794,7 +1794,7 @@ def get_data_stream( """ Returns data streams. - ``_ + ``_ :param name: A comma-separated list of data streams to get; use `*` to get all data streams @@ -1859,7 +1859,7 @@ def get_field_mapping( """ Returns mapping for one or more fields. - ``_ + ``_ :param fields: A comma-separated list of fields :param index: A comma-separated list of index names @@ -1927,7 +1927,7 @@ def get_index_template( """ Returns an index template. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2002,7 +2002,7 @@ def get_mapping( """ Returns mappings for one or more indices. - ``_ + ``_ :param index: A comma-separated list of index names :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -2086,7 +2086,7 @@ def get_settings( """ Returns settings for 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 @@ -2161,7 +2161,7 @@ def get_template( """ Returns an index template. - ``_ + ``_ :param name: The comma separated names of the index templates :param flat_settings: Return settings in flat format (default: false) @@ -2208,7 +2208,7 @@ def migrate_to_data_stream( """ Migrates an alias to a data stream - ``_ + ``_ :param name: The name of the alias to migrate """ @@ -2248,7 +2248,7 @@ def modify_data_stream( """ Modifies a data stream - ``_ + ``_ :param actions: Actions to perform. """ @@ -2314,7 +2314,7 @@ def open( """ Opens an index. - ``_ + ``_ :param index: A comma separated list of indices to open :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -2374,7 +2374,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 """ @@ -2422,7 +2422,7 @@ def put_alias( """ Creates or updates an alias. - ``_ + ``_ :param index: A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. @@ -2501,7 +2501,7 @@ def put_index_template( """ Creates or updates an index template. - ``_ + ``_ :param name: Index or template name :param composed_of: @@ -2619,7 +2619,7 @@ def put_mapping( """ Updates the index mappings. - ``_ + ``_ :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. @@ -2748,7 +2748,7 @@ def put_settings( """ Updates the index settings. - ``_ + ``_ :param settings: :param index: A comma-separated list of index names; use `_all` or empty string @@ -2832,7 +2832,7 @@ def put_template( """ Creates or updates an index template. - ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -2909,7 +2909,7 @@ def recovery( """ Returns information about ongoing index shard recoveries. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -2973,7 +2973,7 @@ def refresh( """ Performs the refresh operation in 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 @@ -3044,7 +3044,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 @@ -3111,7 +3111,7 @@ def resolve_index( """ Returns information about any matching indices, aliases, and data streams - ``_ + ``_ :param name: A comma-separated list of names or wildcard expressions :param expand_wildcards: Whether wildcard expressions should get expanded to @@ -3167,7 +3167,7 @@ def rollover( Updates an alias to point to a new index when the existing index is considered to be too large or too old. - ``_ + ``_ :param alias: The name of the alias to rollover :param new_index: The name of the rollover index @@ -3261,7 +3261,7 @@ def segments( """ Provides low-level information about segments in a Lucene index. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -3346,7 +3346,7 @@ def shard_stores( """ Provides store information for shard copies of 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 @@ -3412,7 +3412,7 @@ def shrink( """ Allow to shrink an existing index into a new index with fewer primary shards. - ``_ + ``_ :param index: The name of the source index to shrink :param target: The name of the target index to shrink into @@ -3489,7 +3489,7 @@ def simulate_index_template( """ Simulate matching the given index name against the index templates in the system - ``_ + ``_ :param name: Index or template name to simulate :param allow_auto_create: @@ -3572,7 +3572,7 @@ def simulate_template( """ Simulate resolving the given template name or body - ``_ + ``_ :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 @@ -3640,7 +3640,7 @@ def split( """ Allows you to split an existing index into a new index with more primary shards. - ``_ + ``_ :param index: The name of the source index to split :param target: The name of the target index to split into @@ -3739,7 +3739,7 @@ def stats( """ Provides statistics on operations happening in an index. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -3847,7 +3847,7 @@ def unfreeze( Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. - ``_ + ``_ :param index: The name of the index to unfreeze :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -3914,7 +3914,7 @@ def update_aliases( """ Updates index aliases. - ``_ + ``_ :param actions: :param master_timeout: Specify timeout for connection to master @@ -3989,7 +3989,7 @@ def validate_query( """ Allows a user to validate a potentially expensive query without executing it. - ``_ + ``_ :param index: A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_sync/client/ingest.py b/elasticsearch/_sync/client/ingest.py index b6ef297dd..7a52a910a 100644 --- a/elasticsearch/_sync/client/ingest.py +++ b/elasticsearch/_sync/client/ingest.py @@ -43,7 +43,7 @@ def delete_pipeline( """ Deletes a pipeline. - ``_ + ``_ :param id: Pipeline ID :param master_timeout: Explicit operation timeout for connection to master node @@ -84,7 +84,7 @@ def geo_ip_stats( """ Returns statistical information about geoip databases - ``_ + ``_ """ __path = "/_ingest/geoip/stats" __query: t.Dict[str, t.Any] = {} @@ -120,7 +120,7 @@ def get_pipeline( """ Returns a pipeline. - ``_ + ``_ :param id: Comma separated list of pipeline ids. Wildcards supported :param master_timeout: Explicit operation timeout for connection to master node @@ -162,7 +162,7 @@ def processor_grok( """ Returns a list of the built-in patterns. - ``_ + ``_ """ __path = "/_ingest/processor/grok" __query: t.Dict[str, t.Any] = {} @@ -211,7 +211,7 @@ def put_pipeline( """ Creates or updates a pipeline. - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param description: Description of the ingest pipeline. @@ -292,7 +292,7 @@ def simulate( """ Allows to simulate a pipeline with example documents. - ``_ + ``_ :param id: Pipeline ID :param docs: diff --git a/elasticsearch/_sync/client/license.py b/elasticsearch/_sync/client/license.py index 4287857f1..163530c15 100644 --- a/elasticsearch/_sync/client/license.py +++ b/elasticsearch/_sync/client/license.py @@ -38,7 +38,7 @@ def delete( """ Deletes licensing information for the cluster - ``_ + ``_ """ __path = "/_license" __query: t.Dict[str, t.Any] = {} @@ -71,7 +71,7 @@ def get( """ Retrieves licensing information for the cluster - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -113,7 +113,7 @@ def get_basic_status( """ Retrieves information about the status of the basic license. - ``_ + ``_ """ __path = "/_license/basic_status" __query: t.Dict[str, t.Any] = {} @@ -144,7 +144,7 @@ def get_trial_status( """ Retrieves information about the status of the trial license. - ``_ + ``_ """ __path = "/_license/trial_status" __query: t.Dict[str, t.Any] = {} @@ -182,7 +182,7 @@ def post( """ Updates the license for the cluster. - ``_ + ``_ :param acknowledge: Specifies whether you acknowledge the license changes. :param license: @@ -230,7 +230,7 @@ def post_start_basic( """ Starts an indefinite basic license. - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -268,7 +268,7 @@ def post_start_trial( """ starts a limited time trial license. - ``_ + ``_ :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 e5a549307..d74a134d9 100644 --- a/elasticsearch/_sync/client/logstash.py +++ b/elasticsearch/_sync/client/logstash.py @@ -39,7 +39,7 @@ def delete_pipeline( """ Deletes Logstash Pipelines used by Central Management - ``_ + ``_ :param id: The ID of the Pipeline """ @@ -75,7 +75,7 @@ def get_pipeline( """ Retrieves Logstash Pipelines used by Central Management - ``_ + ``_ :param id: A comma-separated list of Pipeline IDs """ @@ -114,7 +114,7 @@ def put_pipeline( """ Adds and updates Logstash Pipelines used for Central Management - ``_ + ``_ :param id: The ID of the Pipeline :param pipeline: diff --git a/elasticsearch/_sync/client/migration.py b/elasticsearch/_sync/client/migration.py index 22663c440..ead75d9b2 100644 --- a/elasticsearch/_sync/client/migration.py +++ b/elasticsearch/_sync/client/migration.py @@ -41,7 +41,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. @@ -78,7 +78,7 @@ def get_feature_upgrade_status( """ Find out whether system features need to be upgraded or not - ``_ + ``_ """ __path = "/_migration/system_features" __query: t.Dict[str, t.Any] = {} @@ -109,7 +109,7 @@ def post_feature_upgrade( """ Begin upgrades for system features - ``_ + ``_ """ __path = "/_migration/system_features" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_sync/client/ml.py b/elasticsearch/_sync/client/ml.py index c9e524bf8..046196ad9 100644 --- a/elasticsearch/_sync/client/ml.py +++ b/elasticsearch/_sync/client/ml.py @@ -39,7 +39,7 @@ def clear_trained_model_deployment_cache( """ Clear the cached results from a trained model deployment - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -81,7 +81,7 @@ def close_job( Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. - ``_ + ``_ :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 @@ -136,7 +136,7 @@ def delete_calendar( """ Deletes a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -173,7 +173,7 @@ def delete_calendar_event( """ Deletes scheduled events from a calendar. - ``_ + ``_ :param calendar_id: The ID of the calendar to modify :param event_id: The ID of the event to remove from the calendar @@ -213,7 +213,7 @@ def delete_calendar_job( """ Deletes anomaly detection 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 @@ -255,7 +255,7 @@ def delete_data_frame_analytics( """ Deletes an existing 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 @@ -299,7 +299,7 @@ def delete_datafeed( """ Deletes an existing datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -346,7 +346,7 @@ def delete_expired_data( """ Deletes expired and unused machine learning data. - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -397,7 +397,7 @@ def delete_filter( """ Deletes a filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -436,7 +436,7 @@ def delete_forecast( """ Deletes forecasts from a machine learning job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -493,7 +493,7 @@ def delete_job( """ Deletes an existing anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param force: Use to forcefully delete an opened job; this method is quicker @@ -538,7 +538,7 @@ def delete_model_snapshot( """ Deletes an existing model snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -579,7 +579,7 @@ def delete_trained_model( Deletes an existing trained inference model that is currently 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 @@ -620,7 +620,7 @@ def delete_trained_model_alias( """ Deletes a model alias that refers to the trained model - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -663,7 +663,7 @@ def estimate_model_memory( """ Estimates the model memory - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -721,7 +721,7 @@ def evaluate_data_frame( """ Evaluates the data frame analytics for an annotated index. - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -779,7 +779,7 @@ def explain_data_frame_analytics( """ Explains a data frame analytics config. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -870,7 +870,7 @@ def flush_job( """ Forces any buffered data to be processed by the job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -931,7 +931,7 @@ def forecast( """ Predicts the future behavior of a time series by using its historical behavior. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -997,7 +997,7 @@ def get_buckets( """ Retrieves anomaly detection job results for one or more buckets. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1084,7 +1084,7 @@ def get_calendar_events( """ Retrieves information about the scheduled 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 @@ -1145,7 +1145,7 @@ def get_calendars( """ Retrieves configuration information for 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 @@ -1209,7 +1209,7 @@ def get_categories( """ Retrieves anomaly detection job results for one or more categories. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param category_id: Identifier for the category, which is unique in the job. @@ -1277,7 +1277,7 @@ def get_data_frame_analytics( """ Retrieves configuration information for data frame analytics jobs. - ``_ + ``_ :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 @@ -1343,7 +1343,7 @@ def get_data_frame_analytics_stats( """ Retrieves usage information for data frame analytics jobs. - ``_ + ``_ :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 @@ -1404,7 +1404,7 @@ def get_datafeed_stats( """ Retrieves usage information for 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 @@ -1456,7 +1456,7 @@ def get_datafeeds( """ Retrieves configuration information for 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 @@ -1515,7 +1515,7 @@ def get_filters( """ Retrieves filters. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1570,7 +1570,7 @@ def get_influencers( """ Retrieves anomaly detection job results for one or more influencers. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -1644,7 +1644,7 @@ def get_job_stats( """ Retrieves usage information for anomaly detection jobs. - ``_ + ``_ :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 @@ -1697,7 +1697,7 @@ def get_jobs( """ Retrieves configuration information for anomaly detection jobs. - ``_ + ``_ :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 @@ -1754,7 +1754,7 @@ def get_memory_stats( """ Returns information on how ML is using memory. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -1803,7 +1803,7 @@ def get_model_snapshot_upgrade_stats( """ Gets stats for anomaly detection job model snapshot upgrades that are in progress. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -1866,7 +1866,7 @@ def get_model_snapshots( """ Retrieves information about model snapshots. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -1948,7 +1948,7 @@ def get_overall_buckets( Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. - ``_ + ``_ :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. @@ -2028,7 +2028,7 @@ def get_records( """ Retrieves anomaly records for an anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2111,7 +2111,7 @@ def get_trained_models( """ Retrieves configuration information for a trained inference model. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param allow_no_match: Specifies what to do when the request: - Contains wildcard @@ -2187,7 +2187,7 @@ def get_trained_models_stats( """ Retrieves usage information for trained inference models. - ``_ + ``_ :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. @@ -2245,7 +2245,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 @@ -2296,7 +2296,7 @@ def info( """ Returns defaults and limits used by machine learning. - ``_ + ``_ """ __path = "/_ml/info" __query: t.Dict[str, t.Any] = {} @@ -2331,7 +2331,7 @@ def open_job( """ Opens one or more anomaly detection jobs. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2380,7 +2380,7 @@ def post_calendar_events( """ Posts scheduled events in a 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 @@ -2429,7 +2429,7 @@ def post_data( """ Sends data to an anomaly detection job for analysis. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -2482,7 +2482,7 @@ def preview_data_frame_analytics( """ Previews that will be analyzed given 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 @@ -2533,7 +2533,7 @@ def preview_datafeed( """ Previews a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -2594,7 +2594,7 @@ def put_calendar( """ Instantiates a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -2642,7 +2642,7 @@ def put_calendar_job( """ Adds an anomaly detection job to 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 @@ -2697,7 +2697,7 @@ def put_data_frame_analytics( """ Instantiates 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. @@ -2858,7 +2858,7 @@ def put_datafeed( """ Instantiates a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3004,7 +3004,7 @@ def put_filter( """ Instantiates a filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3067,7 +3067,7 @@ def put_job( """ Instantiates an anomaly detection job. - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -3225,7 +3225,7 @@ def put_trained_model( """ Creates an inference trained model. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param inference_config: The default configuration for inference. This can be @@ -3308,7 +3308,7 @@ def put_trained_model_alias( Creates a new model alias (or reassigns an existing one) to refer to the trained model - ``_ + ``_ :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. @@ -3358,7 +3358,7 @@ def put_trained_model_definition_part( """ Creates 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 @@ -3424,7 +3424,7 @@ def put_trained_model_vocabulary( """ Creates a trained model vocabulary - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -3470,7 +3470,7 @@ def reset_job( """ Resets an existing anomaly detection job. - ``_ + ``_ :param job_id: The ID of the job to reset. :param wait_for_completion: Should this request wait until the operation has @@ -3514,7 +3514,7 @@ def revert_model_snapshot( """ Reverts to a specific snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -3566,7 +3566,7 @@ def set_upgrade_mode( Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -3608,7 +3608,7 @@ def start_data_frame_analytics( """ Starts 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. @@ -3655,7 +3655,7 @@ def start_datafeed( """ Starts one or more datafeeds. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3716,7 +3716,7 @@ def start_trained_model_deployment( """ Start a trained model deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -3789,7 +3789,7 @@ def stop_data_frame_analytics( """ Stops one or more data frame analytics jobs. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3849,7 +3849,7 @@ def stop_datafeed( """ Stops one or more datafeeds. - ``_ + ``_ :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 @@ -3905,7 +3905,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 @@ -3960,7 +3960,7 @@ def update_data_frame_analytics( """ Updates certain properties of 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. @@ -4055,7 +4055,7 @@ def update_datafeed( """ Updates certain properties of a datafeed. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4208,7 +4208,7 @@ def update_filter( """ Updates the description of a filter, adds items, or removes items. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -4276,7 +4276,7 @@ def update_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 @@ -4394,7 +4394,7 @@ def update_model_snapshot( """ Updates certain properties of a snapshot. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -4445,7 +4445,7 @@ def upgrade_job_snapshot( """ Upgrades a given job snapshot to the current major version. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -4503,7 +4503,7 @@ def validate( """ Validates an anomaly detection job. - ``_ + ``_ :param analysis_config: :param analysis_limits: @@ -4566,7 +4566,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 3e29ec232..c21376746 100644 --- a/elasticsearch/_sync/client/monitoring.py +++ b/elasticsearch/_sync/client/monitoring.py @@ -46,7 +46,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 ac77c9aff..f5d39d3d9 100644 --- a/elasticsearch/_sync/client/nodes.py +++ b/elasticsearch/_sync/client/nodes.py @@ -40,7 +40,7 @@ def clear_repositories_metering_archive( """ Removes the archived repositories metering information present 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). @@ -81,7 +81,7 @@ def get_repositories_metering_info( """ Returns cluster repositories metering information. - ``_ + ``_ :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). @@ -134,7 +134,7 @@ def hot_threads( """ Returns information about hot threads on each node in the cluster. - ``_ + ``_ :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 @@ -209,7 +209,7 @@ def info( """ Returns information about nodes in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -271,7 +271,7 @@ def reload_secure_settings( """ Reloads secure settings. - ``_ + ``_ :param node_id: A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. @@ -348,7 +348,7 @@ def stats( """ Returns statistical information about nodes in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -450,7 +450,7 @@ def usage( """ Returns low-level information about REST actions usage on nodes. - ``_ + ``_ :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/rollup.py b/elasticsearch/_sync/client/rollup.py index ec7b0e8bc..ec98d547e 100644 --- a/elasticsearch/_sync/client/rollup.py +++ b/elasticsearch/_sync/client/rollup.py @@ -39,7 +39,7 @@ def delete_job( """ Deletes an existing rollup job. - ``_ + ``_ :param id: The ID of the job to delete """ @@ -75,7 +75,7 @@ def get_jobs( """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :param id: The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs @@ -114,7 +114,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: The ID of the index to check rollup capabilities on, or left blank for all jobs @@ -153,7 +153,7 @@ def get_rollup_index_caps( Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). - ``_ + ``_ :param index: The rollup index or index pattern to obtain rollup capabilities from. @@ -205,7 +205,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. @@ -314,7 +314,7 @@ def rollup_search( """ Enables searching rolled-up data using the standard query DSL. - ``_ + ``_ :param index: The indices or index-pattern(s) (containing rollup or regular data) that should be searched @@ -372,7 +372,7 @@ def start_job( """ Starts an existing, stopped rollup job. - ``_ + ``_ :param id: The ID of the job to start """ @@ -410,7 +410,7 @@ def stop_job( """ Stops an existing, started rollup job. - ``_ + ``_ :param id: The ID of the job to stop :param timeout: Block for (at maximum) the specified duration while waiting for diff --git a/elasticsearch/_sync/client/searchable_snapshots.py b/elasticsearch/_sync/client/searchable_snapshots.py index 5adf5d333..5572929de 100644 --- a/elasticsearch/_sync/client/searchable_snapshots.py +++ b/elasticsearch/_sync/client/searchable_snapshots.py @@ -44,7 +44,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 @@ -106,7 +106,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 @@ -170,7 +170,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 @@ -239,7 +239,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 478580bc2..a6dfba3b7 100644 --- a/elasticsearch/_sync/client/security.py +++ b/elasticsearch/_sync/client/security.py @@ -44,7 +44,7 @@ def activate_user_profile( """ Creates or updates the user profile on behalf of another user. - ``_ + ``_ :param grant_type: :param access_token: @@ -92,7 +92,7 @@ def authenticate( Enables authentication as a user and retrieve information about the authenticated user. - ``_ + ``_ """ __path = "/_security/_authenticate" __query: t.Dict[str, t.Any] = {} @@ -131,7 +131,7 @@ def change_password( """ Changes 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. @@ -185,7 +185,7 @@ def clear_api_key_cache( """ Clear a subset or all entries from the API key cache. - ``_ + ``_ :param ids: A comma-separated list of IDs of API keys to clear from the cache """ @@ -221,7 +221,7 @@ def clear_cached_privileges( """ Evicts application privileges from the native application privileges cache. - ``_ + ``_ :param application: A comma-separated list of application names """ @@ -259,7 +259,7 @@ def clear_cached_realms( Evicts users from the user cache. 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 @@ -298,7 +298,7 @@ def clear_cached_roles( """ Evicts roles from the native role cache. - ``_ + ``_ :param name: Role name """ @@ -336,7 +336,7 @@ def clear_cached_service_tokens( """ Evicts tokens from the service account token caches. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -386,7 +386,7 @@ def create_api_key( """ Creates an API key for access without requiring basic authentication. - ``_ + ``_ :param expiration: Expiration time for the API key. By default, API keys never expire. @@ -452,7 +452,7 @@ def create_service_token( """ Creates a service account token for access without requiring basic authentication. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -512,7 +512,7 @@ def delete_privileges( """ Removes application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -559,7 +559,7 @@ def delete_role( """ Removes roles in the native realm. - ``_ + ``_ :param name: Role name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -603,7 +603,7 @@ def delete_role_mapping( """ Removes role mappings. - ``_ + ``_ :param name: Role-mapping name :param refresh: If `true` (the default) then refresh the affected shards to make @@ -649,7 +649,7 @@ def delete_service_token( """ Deletes a service account token. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -699,7 +699,7 @@ def delete_user( """ Deletes users from the native realm. - ``_ + ``_ :param username: username :param refresh: If `true` (the default) then refresh the affected shards to make @@ -743,7 +743,7 @@ def disable_user( """ Disables 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 @@ -787,7 +787,7 @@ def disable_user_profile( """ Disables a user profile so it's 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 @@ -831,7 +831,7 @@ def enable_user( """ Enables 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 @@ -875,7 +875,7 @@ def enable_user_profile( """ Enables a user profile so it's visible in user profile searches. - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -916,7 +916,7 @@ def enroll_kibana( Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. - ``_ + ``_ """ __path = "/_security/enroll/kibana" __query: t.Dict[str, t.Any] = {} @@ -947,7 +947,7 @@ def enroll_node( """ Allows a new node to enroll to an existing cluster with security enabled. - ``_ + ``_ """ __path = "/_security/enroll/node" __query: t.Dict[str, t.Any] = {} @@ -984,7 +984,7 @@ def get_api_key( """ Retrieves information for one or more API keys. - ``_ + ``_ :param id: API key id of the API key to be retrieved :param name: API key name of the API key to be retrieved @@ -1037,7 +1037,7 @@ def get_builtin_privileges( Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ __path = "/_security/privilege/_builtin" __query: t.Dict[str, t.Any] = {} @@ -1070,7 +1070,7 @@ def get_privileges( """ Retrieves application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -1110,7 +1110,7 @@ def get_role( """ Retrieves roles in the native realm. - ``_ + ``_ :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 @@ -1149,7 +1149,7 @@ def get_role_mapping( """ Retrieves role mappings. - ``_ + ``_ :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 @@ -1191,7 +1191,7 @@ def get_service_accounts( """ Retrieves information about service accounts. - ``_ + ``_ :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 @@ -1235,7 +1235,7 @@ def get_service_credentials( """ Retrieves information of all service credentials for a service account. - ``_ + ``_ :param namespace: Name of the namespace. :param service: Name of the service name. @@ -1286,7 +1286,7 @@ def get_token( """ Creates a bearer token for access without requiring basic authentication. - ``_ + ``_ :param grant_type: :param kerberos_ticket: @@ -1341,7 +1341,7 @@ def get_user( """ Retrieves 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 @@ -1386,7 +1386,7 @@ def get_user_privileges( """ Retrieves security privileges for the logged in user. - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -1432,7 +1432,7 @@ def get_user_profile( """ Retrieves user profiles for the given unique ID(s). - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: List of filters for the `data` field of the profile document. To @@ -1482,7 +1482,7 @@ def grant_api_key( """ Creates an API key on behalf of another user. - ``_ + ``_ :param api_key: :param grant_type: @@ -1563,7 +1563,7 @@ def has_privileges( """ Determines whether the specified user has a specified list of privileges. - ``_ + ``_ :param user: Username :param application: @@ -1614,7 +1614,7 @@ def has_privileges_user_profile( Determines whether the users associated with the specified profile IDs have all the requested privileges. - ``_ + ``_ :param privileges: :param uids: A list of profile IDs. The privileges are checked for associated @@ -1666,7 +1666,7 @@ def invalidate_api_key( """ Invalidates one or more API keys. - ``_ + ``_ :param id: :param ids: @@ -1723,7 +1723,7 @@ def invalidate_token( """ Invalidates one or more access tokens or refresh tokens. - ``_ + ``_ :param realm_name: :param refresh_token: @@ -1774,7 +1774,7 @@ def put_privileges( """ Adds or updates application privileges. - ``_ + ``_ :param privileges: :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1849,7 +1849,7 @@ def put_role( """ Adds and updates roles in the native realm. - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -1931,7 +1931,7 @@ def put_role_mapping( """ Creates and updates role mappings. - ``_ + ``_ :param name: Role-mapping name :param enabled: @@ -2001,7 +2001,7 @@ def put_user( Adds and updates users in the native realm. These users are commonly referred to as native users. - ``_ + ``_ :param username: The username of the User :param email: @@ -2085,7 +2085,7 @@ def query_api_keys( """ Retrieves information for API keys using a subset of query DSL - ``_ + ``_ :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 @@ -2166,7 +2166,7 @@ def saml_authenticate( Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair - ``_ + ``_ :param content: The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document. @@ -2221,7 +2221,7 @@ def saml_complete_logout( """ 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. @@ -2280,7 +2280,7 @@ def saml_invalidate( """ Consumes a SAML LogoutRequest - ``_ + ``_ :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 @@ -2341,7 +2341,7 @@ def saml_logout( Invalidates an access token and a refresh token that were generated via the SAML Authenticate API - ``_ + ``_ :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 @@ -2391,7 +2391,7 @@ def saml_prepare_authentication( """ Creates a SAML authentication request - ``_ + ``_ :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 @@ -2440,7 +2440,7 @@ def saml_service_provider_metadata( """ Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -2481,7 +2481,7 @@ def suggest_user_profiles( """ 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=` @@ -2542,7 +2542,7 @@ def update_api_key( """ Updates attributes of an existing API key. - ``_ + ``_ :param id: The ID of the API key to update. :param metadata: Arbitrary metadata that you want to associate with the API key. @@ -2607,7 +2607,7 @@ def update_user_profile_data( """ Update application specific data for the user profile of the given 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 92e455941..31a8b26d4 100644 --- a/elasticsearch/_sync/client/slm.py +++ b/elasticsearch/_sync/client/slm.py @@ -39,7 +39,7 @@ def delete_lifecycle( """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove """ @@ -76,7 +76,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 """ @@ -111,7 +111,7 @@ def execute_retention( """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ __path = "/_slm/_execute_retention" __query: t.Dict[str, t.Any] = {} @@ -146,7 +146,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 """ @@ -183,7 +183,7 @@ def get_stats( Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ __path = "/_slm/stats" __query: t.Dict[str, t.Any] = {} @@ -214,7 +214,7 @@ def get_status( """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ __path = "/_slm/status" __query: t.Dict[str, t.Any] = {} @@ -257,7 +257,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. @@ -328,7 +328,7 @@ def start( """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ __path = "/_slm/start" __query: t.Dict[str, t.Any] = {} @@ -359,7 +359,7 @@ def stop( """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ __path = "/_slm/stop" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_sync/client/snapshot.py b/elasticsearch/_sync/client/snapshot.py index 6e490f7f1..72a6a3f9d 100644 --- a/elasticsearch/_sync/client/snapshot.py +++ b/elasticsearch/_sync/client/snapshot.py @@ -43,7 +43,7 @@ def cleanup_repository( """ Removes stale data from repository. - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -94,7 +94,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 @@ -163,7 +163,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. @@ -261,7 +261,7 @@ def create_repository( """ Creates a repository. - ``_ + ``_ :param name: A repository name :param settings: @@ -324,7 +324,7 @@ def delete( """ Deletes one or more snapshots. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -370,7 +370,7 @@ def delete_repository( """ Deletes a repository. - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -434,7 +434,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. @@ -541,7 +541,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 @@ -605,7 +605,7 @@ def restore( """ Restores a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -690,7 +690,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 @@ -741,7 +741,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 31609daab..5701426d1 100644 --- a/elasticsearch/_sync/client/sql.py +++ b/elasticsearch/_sync/client/sql.py @@ -41,7 +41,7 @@ def clear_cursor( """ Clears the SQL cursor - ``_ + ``_ :param cursor: """ @@ -81,7 +81,7 @@ def delete_async( Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. - ``_ + ``_ :param id: The async search ID """ @@ -124,7 +124,7 @@ def get_async( Returns the current status and available results for an async SQL search or stored synchronous SQL search - ``_ + ``_ :param id: The async search ID :param delimiter: Separator for CSV results. The API only supports this parameter @@ -178,7 +178,7 @@ def get_async_status( Returns the current status of an async SQL search or a stored synchronous SQL search - ``_ + ``_ :param id: The async search ID """ @@ -237,7 +237,7 @@ def query( """ Executes a SQL request - ``_ + ``_ :param catalog: Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. @@ -338,7 +338,7 @@ def translate( """ Translates SQL into Elasticsearch queries - ``_ + ``_ :param query: :param fetch_size: diff --git a/elasticsearch/_sync/client/ssl.py b/elasticsearch/_sync/client/ssl.py index a9b39f0b2..af3da02d7 100644 --- a/elasticsearch/_sync/client/ssl.py +++ b/elasticsearch/_sync/client/ssl.py @@ -39,7 +39,7 @@ def certificates( Retrieves information about the X.509 certificates used to encrypt communications in the cluster. - ``_ + ``_ """ __path = "/_ssl/certificates" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_sync/client/tasks.py b/elasticsearch/_sync/client/tasks.py index c15ef6b7b..0657a0424 100644 --- a/elasticsearch/_sync/client/tasks.py +++ b/elasticsearch/_sync/client/tasks.py @@ -45,7 +45,7 @@ def cancel( """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :param task_id: Cancel the task with specified task id (node_id:task_number) :param actions: A comma-separated list of actions that should be cancelled. Leave @@ -101,7 +101,7 @@ def get( """ Returns information about a task. - ``_ + ``_ :param task_id: Return the task with specified id (node_id:task_number) :param timeout: Explicit operation timeout @@ -157,7 +157,7 @@ def list( """ Returns a list of tasks. - ``_ + ``_ :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 d181cb3fa..df78e43e7 100644 --- a/elasticsearch/_sync/client/text_structure.py +++ b/elasticsearch/_sync/client/text_structure.py @@ -50,7 +50,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 diff --git a/elasticsearch/_sync/client/transform.py b/elasticsearch/_sync/client/transform.py index 9c72c70ea..893addc60 100644 --- a/elasticsearch/_sync/client/transform.py +++ b/elasticsearch/_sync/client/transform.py @@ -41,7 +41,7 @@ def delete_transform( """ Deletes an existing transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param force: If this value is false, the transform must be stopped before it @@ -94,7 +94,7 @@ def get_transform( """ 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 @@ -156,7 +156,7 @@ def 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 @@ -219,7 +219,7 @@ def preview_transform( """ Previews a transform. - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -316,7 +316,7 @@ def put_transform( """ Instantiates a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -410,7 +410,7 @@ def reset_transform( """ Resets an existing transform. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -454,7 +454,7 @@ def start_transform( """ Starts one or more transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Period to wait for a response. If no response is received before @@ -499,7 +499,7 @@ def stop_transform( """ 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, @@ -578,7 +578,7 @@ def update_transform( """ Updates certain properties of a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param defer_validation: When true, deferrable validations are not run. This @@ -653,7 +653,7 @@ def upgrade_transforms( """ Upgrades all transforms. - ``_ + ``_ :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 e4d256593..ebfc3e995 100644 --- a/elasticsearch/_sync/client/watcher.py +++ b/elasticsearch/_sync/client/watcher.py @@ -42,7 +42,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 @@ -84,7 +84,7 @@ def activate_watch( """ Activates a currently inactive watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -120,7 +120,7 @@ def deactivate_watch( """ Deactivates a currently active watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -156,7 +156,7 @@ def delete_watch( """ Removes a watch from Watcher. - ``_ + ``_ :param id: Watch ID """ @@ -210,7 +210,7 @@ def execute_watch( """ Forces the execution of a stored watch. - ``_ + ``_ :param id: Identifier for the watch. :param action_modes: Determines how to handle the watch actions as part of the @@ -285,7 +285,7 @@ def get_watch( """ Retrieves a watch by its ID. - ``_ + ``_ :param id: Watch ID """ @@ -334,7 +334,7 @@ def put_watch( """ Creates a new watch, or updates an existing one. - ``_ + ``_ :param id: Watch ID :param actions: @@ -430,7 +430,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. @@ -494,7 +494,7 @@ def start( """ Starts Watcher if it is not already running. - ``_ + ``_ """ __path = "/_watcher/_start" __query: t.Dict[str, t.Any] = {} @@ -549,7 +549,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 @@ -589,7 +589,7 @@ def stop( """ Stops Watcher if it is running. - ``_ + ``_ """ __path = "/_watcher/_stop" __query: t.Dict[str, t.Any] = {} diff --git a/elasticsearch/_sync/client/xpack.py b/elasticsearch/_sync/client/xpack.py index 2fd5bbf24..ce0de624e 100644 --- a/elasticsearch/_sync/client/xpack.py +++ b/elasticsearch/_sync/client/xpack.py @@ -45,7 +45,7 @@ def info( """ Retrieves 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 @@ -87,7 +87,7 @@ def usage( """ Retrieves usage information about the installed X-Pack features. - ``_ + ``_ :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