diff --git a/elasticsearch/_async/client/__init__.py b/elasticsearch/_async/client/__init__.py index 5b2979f15..8429d6245 100644 --- a/elasticsearch/_async/client/__init__.py +++ b/elasticsearch/_async/client/__init__.py @@ -641,7 +641,7 @@ async def bulk( Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed. - ``_ + ``_ :param operations: :param index: Name of the data stream, index, or index alias to perform bulk @@ -740,7 +740,7 @@ async def clear_scroll( """ Clears the search context and results for a scrolling search. - ``_ + ``_ :param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`. """ @@ -790,7 +790,7 @@ async def close_point_in_time( """ Closes a point-in-time. - ``_ + ``_ :param id: The ID of the point-in-time. """ @@ -864,7 +864,7 @@ async def count( """ Returns number of documents matching a query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -999,7 +999,7 @@ async def create( If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template @@ -1103,7 +1103,7 @@ async def delete( """ Removes a JSON document from the specified index. - ``_ + ``_ :param index: Name of the target index. :param id: Unique identifier for the document. @@ -1227,7 +1227,7 @@ async def delete_by_query( """ Deletes documents that match the specified query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -1405,7 +1405,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 ID for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -1453,7 +1453,7 @@ async def delete_script( """ Deletes a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Period to wait for a connection to the master node. If @@ -1521,7 +1521,7 @@ async def exists( """ Checks if a document in an index exists. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1622,7 +1622,7 @@ async def exists_source( """ Checks if a document's `_source` is stored. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1723,7 +1723,7 @@ async def explain( Returns information about why a specific document matches (or doesn’t match) a query. - ``_ + ``_ :param index: Index names used to limit the request. Only a single index name can be provided to this parameter. @@ -1845,7 +1845,7 @@ async def field_caps( like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -1961,7 +1961,7 @@ async def get( """ Returns a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2052,7 +2052,7 @@ async def get_script( """ Retrieves a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Specify timeout for connection to master @@ -2094,7 +2094,7 @@ async def get_script_context( """ Returns all script contexts. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_context" @@ -2129,7 +2129,7 @@ async def get_script_languages( """ Returns available script types, languages and contexts - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_language" @@ -2184,7 +2184,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. @@ -2267,7 +2267,7 @@ async def health_report( """ Returns the health of the cluster. - ``_ + ``_ :param feature: A feature of the cluster, as returned by the top-level health report API. @@ -2344,7 +2344,7 @@ async def index( If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. :param document: @@ -2453,7 +2453,7 @@ async def info( """ Returns basic information about the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/" @@ -2509,7 +2509,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 @@ -2610,7 +2610,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. @@ -2730,7 +2730,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 @@ -2853,7 +2853,7 @@ async def msearch_template( """ Runs multiple templated searches with a single request. - ``_ + ``_ :param search_templates: :param index: Comma-separated list of data streams, indices, and aliases to search. @@ -2948,7 +2948,7 @@ async def mtermvectors( """ Returns multiple termvectors in one request. - ``_ + ``_ :param index: Name of the index that contains the documents. :param docs: Array of existing or artificial documents. @@ -3061,7 +3061,7 @@ async def open_point_in_time( then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. - ``_ + ``_ :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 @@ -3133,7 +3133,7 @@ async def put_script( """ Creates or updates a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. Must be unique within the cluster. @@ -3219,7 +3219,7 @@ async def rank_eval( Enables you 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. @@ -3315,7 +3315,7 @@ async def reindex( source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. - ``_ + ``_ :param dest: The destination you are copying to. :param source: The source you are copying from. @@ -3411,7 +3411,7 @@ async def reindex_rethrottle( """ Copies documents from a source to a destination. - ``_ + ``_ :param task_id: Identifier for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -3462,7 +3462,7 @@ async def render_search_template( """ Renders a search template as a search request body. - ``_ + ``_ :param id: ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. @@ -3530,7 +3530,7 @@ async def scripts_painless_execute( """ Runs a script and returns a result. - ``_ + ``_ :param context: The context that the script should run in. :param context_setup: Additional parameters for the `context`. @@ -3588,7 +3588,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 @@ -3779,7 +3779,7 @@ async def search( search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -4201,7 +4201,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 @@ -4356,7 +4356,7 @@ async def search_shards( Returns information about the indices and shards that a search request would be executed against. - ``_ + ``_ :param index: Returns the indices and shards that a search request would be executed against. @@ -4457,7 +4457,7 @@ async def search_template( """ Runs a search with a search template. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). @@ -4591,7 +4591,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. @@ -4690,7 +4690,7 @@ async def termvectors( Returns information and statistics about terms in the fields of a particular document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -4832,7 +4832,7 @@ async def update( """ Updates a document with a script or partial document. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -4999,7 +4999,7 @@ async def update_by_query( an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -5192,7 +5192,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 ID for the task. :param requests_per_second: The throttle for this request in sub-requests per diff --git a/elasticsearch/_async/client/async_search.py b/elasticsearch/_async/client/async_search.py index b576b39dc..ba3504dae 100644 --- a/elasticsearch/_async/client/async_search.py +++ b/elasticsearch/_async/client/async_search.py @@ -42,7 +42,7 @@ async def delete( search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. - ``_ + ``_ :param id: A unique identifier for the async search. """ @@ -90,7 +90,7 @@ async def get( results of a specific async search is restricted to the user or API key that submitted it. - ``_ + ``_ :param id: A unique identifier for the async search. :param keep_alive: Specifies how long the async search should be available in @@ -153,7 +153,7 @@ async def status( Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. - ``_ + ``_ :param id: A unique identifier for the async search. """ @@ -333,7 +333,7 @@ async def submit( response can be set by changing the `search.max_async_search_response_size` cluster level setting. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py index b558e94a5..30b9193c4 100644 --- a/elasticsearch/_async/client/autoscaling.py +++ b/elasticsearch/_async/client/autoscaling.py @@ -39,7 +39,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 """ @@ -79,7 +79,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_parts: t.Dict[str, str] = {} __path = "/_autoscaling/capacity" @@ -116,7 +116,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 """ @@ -161,7 +161,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 3035c93b7..a4b151c8c 100644 --- a/elasticsearch/_async/client/cat.py +++ b/elasticsearch/_async/client/cat.py @@ -59,7 +59,7 @@ async def aliases( not intended for use by applications. For application consumption, use the aliases API. - ``_ + ``_ :param name: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. @@ -149,7 +149,7 @@ async def allocation( disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. - ``_ + ``_ :param node_id: Comma-separated list of node identifiers or names used to limit the returned information. @@ -237,7 +237,7 @@ async def component_templates( using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API. - ``_ + ``_ :param name: The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned. @@ -323,7 +323,7 @@ async def count( console. They are not intended for use by applications. For application consumption, use the count API. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -411,7 +411,7 @@ async def fielddata( using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. - ``_ + ``_ :param fields: Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. @@ -508,7 +508,7 @@ async def health( across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -587,7 +587,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`. @@ -687,7 +687,7 @@ async def indices( document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -791,7 +791,7 @@ async def master( command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -899,7 +899,7 @@ async def ml_data_frame_analytics( console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API. - ``_ + ``_ :param id: The ID of the data frame analytics to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -1023,7 +1023,7 @@ async def ml_datafeeds( using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1154,7 +1154,7 @@ async def ml_jobs( for use by applications. For application consumption, use the get anomaly detection job statistics API. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param allow_no_match: Specifies what to do when the request: * Contains wildcard @@ -1285,7 +1285,7 @@ async def ml_trained_models( command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API. - ``_ + ``_ :param model_id: A unique identifier for the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -1384,7 +1384,7 @@ async def nodeattrs( are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1465,7 +1465,7 @@ async def nodes( are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param bytes: The unit used to display byte values. :param format: Specifies the format to return the columnar data in, can be set @@ -1552,7 +1552,7 @@ async def pending_tasks( console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1628,7 +1628,7 @@ async def plugins( They are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1714,7 +1714,7 @@ async def recovery( line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -1808,7 +1808,7 @@ async def repositories( are not intended for use by applications. For application consumption, use the get snapshot repository API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1889,7 +1889,7 @@ async def segments( console. They are not intended for use by applications. For application consumption, use the index segments API. - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -1980,7 +1980,7 @@ async def shards( for human consumption using the command line or Kibana console. They are not intended for use by applications. - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2070,7 +2070,7 @@ async def snapshots( console. They are not intended for use by applications. For application consumption, use the get snapshot API. - ``_ + ``_ :param repository: A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. @@ -2162,7 +2162,7 @@ async def tasks( console. They are not intended for use by applications. For application consumption, use the task management API. - ``_ + ``_ :param actions: The task action names, which are used to limit the response. :param detailed: If `true`, the response includes detailed information about @@ -2254,7 +2254,7 @@ async def templates( console. They are not intended for use by applications. For application consumption, use the get index template API. - ``_ + ``_ :param name: The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. @@ -2342,7 +2342,7 @@ async def thread_pool( They are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param thread_pool_patterns: A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. @@ -2463,7 +2463,7 @@ async def transforms( line. They are not intended for use by applications. For application consumption, use the get transform statistics API. - ``_ + ``_ :param transform_id: A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all diff --git a/elasticsearch/_async/client/ccr.py b/elasticsearch/_async/client/ccr.py index dea683da1..ac5eee199 100644 --- a/elasticsearch/_async/client/ccr.py +++ b/elasticsearch/_async/client/ccr.py @@ -38,7 +38,7 @@ async def delete_auto_follow_pattern( """ Deletes auto-follow patterns. - ``_ + ``_ :param name: The name of the auto follow pattern. """ @@ -113,7 +113,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: @@ -205,7 +205,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 @@ -247,7 +247,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 @@ -300,7 +300,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 @@ -357,7 +357,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. @@ -401,7 +401,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. @@ -443,7 +443,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. @@ -524,7 +524,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 @@ -648,7 +648,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. @@ -717,7 +717,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: @@ -799,7 +799,7 @@ async def stats( """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ccr/stats" @@ -836,7 +836,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 c5de06ab8..c78dc1b31 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. @@ -118,7 +118,7 @@ async def delete_component_template( Deletes component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. - ``_ + ``_ :param name: Comma-separated list or wildcard expression of component template names used to limit the request. @@ -168,7 +168,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 @@ -217,7 +217,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. @@ -274,7 +274,7 @@ async def get_component_template( """ Retrieves information about component templates. - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -340,7 +340,7 @@ async def get_settings( Returns cluster-wide settings. By default, it returns only settings that have been explicitly defined. - ``_ + ``_ :param flat_settings: If `true`, returns settings in flat format. :param include_defaults: If `true`, returns default cluster settings from the @@ -432,7 +432,7 @@ async def health( by the worst shard status. The cluster status is controlled by the worst index status. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target @@ -538,7 +538,7 @@ async def info( """ Returns different information about the cluster. - ``_ + ``_ :param target: Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. @@ -589,7 +589,7 @@ async def pending_tasks( update, the activity of this task might be reported by both task api and pending cluster tasks API. - ``_ + ``_ :param local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. @@ -637,7 +637,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 @@ -713,7 +713,7 @@ async def put_component_template( You can include comments anywhere in the request body except before the opening curly bracket. - ``_ + ``_ :param name: Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; @@ -804,7 +804,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 @@ -860,7 +860,7 @@ async def remote_info( cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_remote/info" @@ -907,7 +907,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 @@ -998,7 +998,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 @@ -1084,7 +1084,7 @@ async def stats( size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). - ``_ + ``_ :param node_id: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. diff --git a/elasticsearch/_async/client/dangling_indices.py b/elasticsearch/_async/client/dangling_indices.py index ee33a148f..3efdcdaa3 100644 --- a/elasticsearch/_async/client/dangling_indices.py +++ b/elasticsearch/_async/client/dangling_indices.py @@ -43,7 +43,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 @@ -100,7 +100,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 @@ -151,7 +151,7 @@ async def list_dangling_indices( """ Returns all dangling indices. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_dangling" diff --git a/elasticsearch/_async/client/enrich.py b/elasticsearch/_async/client/enrich.py index 63c7e8ed9..a5f1f09d4 100644 --- a/elasticsearch/_async/client/enrich.py +++ b/elasticsearch/_async/client/enrich.py @@ -38,7 +38,7 @@ async def delete_policy( """ Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :param name: Enrich policy to delete. """ @@ -79,7 +79,7 @@ async def execute_policy( """ Creates the enrich index for an existing enrich policy. - ``_ + ``_ :param name: Enrich policy to execute. :param wait_for_completion: If `true`, the request blocks other enrich policy @@ -123,7 +123,7 @@ async def get_policy( """ Returns information about an enrich policy. - ``_ + ``_ :param name: Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. @@ -173,7 +173,7 @@ async def put_policy( """ Creates an enrich policy. - ``_ + ``_ :param name: Name of the enrich policy to create or update. :param geo_match: Matches enrich data to incoming documents based on a `geo_shape` @@ -227,7 +227,7 @@ async def stats( Returns enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_enrich/_stats" diff --git a/elasticsearch/_async/client/eql.py b/elasticsearch/_async/client/eql.py index 8e032a273..71677e232 100644 --- a/elasticsearch/_async/client/eql.py +++ b/elasticsearch/_async/client/eql.py @@ -39,7 +39,7 @@ async def delete( Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. - ``_ + ``_ :param id: Identifier for the search to delete. A search ID is provided in the EQL search API's response for an async search. A search ID is also provided @@ -86,7 +86,7 @@ async def get( Returns the current status and available results for an async EQL search or a stored synchronous EQL search. - ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -137,7 +137,7 @@ async def get_status( Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. - ``_ + ``_ :param id: Identifier for the search. """ @@ -225,7 +225,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/esql.py b/elasticsearch/_async/client/esql.py index 99739035e..23e858e35 100644 --- a/elasticsearch/_async/client/esql.py +++ b/elasticsearch/_async/client/esql.py @@ -48,7 +48,7 @@ async def query( """ Executes an ES|QL request - ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. diff --git a/elasticsearch/_async/client/features.py b/elasticsearch/_async/client/features.py index a6fbf4d14..76e075079 100644 --- a/elasticsearch/_async/client/features.py +++ b/elasticsearch/_async/client/features.py @@ -38,7 +38,7 @@ async def get_features( Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features" @@ -73,7 +73,7 @@ async def reset_features( """ Resets the internal state of features, usually by deleting system indices - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features/_reset" diff --git a/elasticsearch/_async/client/fleet.py b/elasticsearch/_async/client/fleet.py index 6c1f41034..da8b98c90 100644 --- a/elasticsearch/_async/client/fleet.py +++ b/elasticsearch/_async/client/fleet.py @@ -43,7 +43,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 998b990b9..49a58ed81 100644 --- a/elasticsearch/_async/client/graph.py +++ b/elasticsearch/_async/client/graph.py @@ -48,7 +48,7 @@ async def explore( Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. - ``_ + ``_ :param index: Name of the index. :param connections: Specifies or more fields from which you want to extract terms diff --git a/elasticsearch/_async/client/ilm.py b/elasticsearch/_async/client/ilm.py index 394b7f98c..4fc3f676e 100644 --- a/elasticsearch/_async/client/ilm.py +++ b/elasticsearch/_async/client/ilm.py @@ -44,7 +44,7 @@ async def delete_lifecycle( that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -101,7 +101,7 @@ async def explain_lifecycle( currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -165,7 +165,7 @@ async def get_lifecycle( """ Retrieves a lifecycle policy. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -216,7 +216,7 @@ async def get_status( """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ilm/status" @@ -260,7 +260,7 @@ async def migrate_to_data_tiers( data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers. - ``_ + ``_ :param dry_run: If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides @@ -320,7 +320,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: @@ -382,7 +382,7 @@ async def put_lifecycle( Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -441,7 +441,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 """ @@ -481,7 +481,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 @@ -525,7 +525,7 @@ async def start( """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ :param master_timeout: :param timeout: @@ -572,7 +572,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 392b054ab..a183f2bcc 100644 --- a/elasticsearch/_async/client/indices.py +++ b/elasticsearch/_async/client/indices.py @@ -53,7 +53,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) @@ -140,7 +140,7 @@ async def analyze( """ Performs analysis on a text string and returns the resulting tokens. - ``_ + ``_ :param index: Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the @@ -242,7 +242,7 @@ async def clear_cache( Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -329,7 +329,7 @@ async def clone( """ Clones an existing index. - ``_ + ``_ :param index: Name of the source index to clone. :param target: Name of the target index to create. @@ -419,7 +419,7 @@ async def close( """ Closes an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -502,7 +502,7 @@ async def create( """ Creates a new index. - ``_ + ``_ :param index: Name of the index you wish to create. :param aliases: Aliases for the index. @@ -574,7 +574,7 @@ async def create_data_stream( Creates a data stream. You must have a matching index template with data stream enabled. - ``_ + ``_ :param name: Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, @@ -626,7 +626,7 @@ async def data_streams_stats( """ Retrieves statistics for one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a @@ -689,7 +689,7 @@ async def delete( """ Deletes one or more indices. - ``_ + ``_ :param index: Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. @@ -761,7 +761,7 @@ async def delete_alias( """ Removes a data stream or index from an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). @@ -828,7 +828,7 @@ async def delete_data_lifecycle( Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle - ``_ + ``_ :param name: A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams @@ -887,7 +887,7 @@ async def delete_data_stream( """ Deletes one or more data streams and their backing indices. - ``_ + ``_ :param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. @@ -934,11 +934,12 @@ async def delete_index_template( timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None, ) -> ObjectApiResponse[t.Any]: """ - The provided may contain multiple template names separated by - a comma. If multiple template names are specified then there is no wildcard support - and the provided names should match completely with existing templates. + Delete an index template. The provided may contain multiple + template names separated by a comma. If multiple template names are specified + then there is no wildcard support and the provided names should match completely + with existing templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -992,7 +993,7 @@ async def delete_template( """ Deletes a legacy index template. - ``_ + ``_ :param name: The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. @@ -1054,7 +1055,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 @@ -1129,7 +1130,7 @@ async def downsample( (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. - ``_ + ``_ :param index: Name of the time series index to downsample. :param target_index: Name of the index to create. @@ -1197,7 +1198,7 @@ async def exists( """ Checks if a data stream, index, or alias exists. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1275,7 +1276,7 @@ async def exists_alias( """ Checks if an alias exists. - ``_ + ``_ :param name: Comma-separated list of aliases to check. Supports wildcards (`*`). :param index: Comma-separated list of data streams or indices used to limit the @@ -1347,7 +1348,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. @@ -1396,9 +1397,10 @@ async def exists_template( pretty: t.Optional[bool] = None, ) -> HeadApiResponse: """ - Returns information about whether a particular index template exists. + Check existence of index templates. Returns information about whether a particular + index template exists. - ``_ + ``_ :param name: The comma separated names of the index templates :param flat_settings: Return settings in flat format (default: false) @@ -1453,7 +1455,7 @@ async def explain_data_lifecycle( Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. - ``_ + ``_ :param index: The name of the index to explain :param include_defaults: indicates if the API should return the default values @@ -1518,7 +1520,7 @@ async def field_usage_stats( """ Returns field usage information for each shard and field of an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1606,7 +1608,7 @@ async def flush( """ Flushes one or more data streams or indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this @@ -1689,7 +1691,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 @@ -1787,7 +1789,7 @@ async def get( Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -1876,7 +1878,7 @@ async def get_alias( """ Retrieves information for one or more aliases. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, @@ -1957,7 +1959,7 @@ async def get_data_lifecycle( """ Retrieves the data stream lifecycle configuration of one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` @@ -2016,7 +2018,7 @@ async def get_data_stream( """ Retrieves information about one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are @@ -2083,7 +2085,7 @@ async def get_field_mapping( Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. - ``_ + ``_ :param fields: Comma-separated list or wildcard expression of fields used to limit returned information. @@ -2160,9 +2162,9 @@ async def get_index_template( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more index templates. + Get index templates. Returns information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2238,7 +2240,7 @@ async def get_mapping( Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2325,7 +2327,7 @@ async def get_settings( Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2412,9 +2414,9 @@ async def get_template( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves information about one or more index templates. + Get index templates. Retrieves information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, @@ -2478,7 +2480,7 @@ async def migrate_to_data_stream( the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream. - ``_ + ``_ :param name: Name of the index alias to convert to a data stream. """ @@ -2521,7 +2523,7 @@ async def modify_data_stream( """ Performs one or more data stream modification actions in a single atomic operation. - ``_ + ``_ :param actions: Actions to perform. """ @@ -2583,7 +2585,7 @@ async def open( """ Opens a closed index. For data streams, the API opens any closed backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly @@ -2658,7 +2660,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 """ @@ -2717,7 +2719,7 @@ async def put_alias( """ Adds a data stream or index to an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices @@ -2823,7 +2825,7 @@ async def put_data_lifecycle( """ Update the data lifecycle of the specified data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`. @@ -2924,10 +2926,10 @@ async def put_index_template( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates an index template. Index templates define settings, mappings, + Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: Index or template name :param allow_auto_create: This setting overrides the value of the `action.auto_create_index` @@ -3090,7 +3092,7 @@ async def put_mapping( to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default. - ``_ + ``_ :param index: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. @@ -3222,7 +3224,7 @@ async def put_settings( Changes a dynamic index setting in real time. For data streams, index setting changes are applied to all backing indices by default. - ``_ + ``_ :param settings: :param index: Comma-separated list of data streams, indices, and aliases used @@ -3326,10 +3328,10 @@ async def put_template( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates an index template. Index templates define settings, mappings, + Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -3411,7 +3413,7 @@ async def recovery( indices. For data streams, the API returns information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3475,7 +3477,7 @@ async def refresh( for search. For data streams, the API runs the refresh operation on the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3545,7 +3547,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 @@ -3611,7 +3613,7 @@ async def resolve_cluster( including the local cluster, if included. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3683,7 +3685,7 @@ async def resolve_index( Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3747,7 +3749,7 @@ async def rollover( """ Creates a new index for a data stream or index alias. - ``_ + ``_ :param alias: Name of the data stream or index alias to roll over. :param new_index: Name of the index to create. Supports date math. Data streams @@ -3853,7 +3855,7 @@ async def segments( Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3933,7 +3935,7 @@ async def shard_stores( Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices. - ``_ + ``_ :param index: List of data streams, indices, and aliases used to limit the request. :param allow_no_indices: If false, the request returns an error if any wildcard @@ -4006,7 +4008,7 @@ async def shrink( """ Shrinks an existing index into a new index with fewer primary shards. - ``_ + ``_ :param index: Name of the source index to shrink. :param target: Name of the target index to create. @@ -4081,9 +4083,10 @@ async def simulate_index_template( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ + Simulate an index. Returns the index configuration that would be applied to the + specified index from an existing index template. - - ``_ + ``_ :param name: Name of the index to simulate :param include_defaults: If true, returns all relevant default configurations @@ -4160,9 +4163,10 @@ async def simulate_template( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the index configuration that would be applied by a particular index template. + Simulate an index template. Returns the index configuration that would be applied + by a particular index template. - ``_ + ``_ :param name: Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template @@ -4295,7 +4299,7 @@ async def split( """ Splits an existing index into a new index with more primary shards. - ``_ + ``_ :param index: Name of the source index to split. :param target: Name of the target index to create. @@ -4388,7 +4392,7 @@ async def stats( Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -4493,7 +4497,7 @@ async def unfreeze( """ Unfreezes an index. - ``_ + ``_ :param index: Identifier for the index. :param allow_no_indices: If `false`, the request returns an error if any wildcard @@ -4569,7 +4573,7 @@ async def update_aliases( """ Adds a data stream or index to an alias. - ``_ + ``_ :param actions: Actions to perform. :param master_timeout: Period to wait for a connection to the master node. If @@ -4644,7 +4648,7 @@ async def validate_query( """ Validates a potentially expensive query without executing it. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this diff --git a/elasticsearch/_async/client/inference.py b/elasticsearch/_async/client/inference.py index 89df532ee..c73c9d027 100644 --- a/elasticsearch/_async/client/inference.py +++ b/elasticsearch/_async/client/inference.py @@ -46,7 +46,7 @@ async def delete( """ Delete an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param task_type: The task type @@ -111,7 +111,7 @@ async def get( """ Get an inference endpoint - ``_ + ``_ :param task_type: The task type :param inference_id: The inference Id @@ -174,7 +174,7 @@ async def inference( """ Perform inference on the service - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -257,7 +257,7 @@ async def put( """ Create an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param inference_config: diff --git a/elasticsearch/_async/client/ingest.py b/elasticsearch/_async/client/ingest.py index 321bd6181..e20f8b161 100644 --- a/elasticsearch/_async/client/ingest.py +++ b/elasticsearch/_async/client/ingest.py @@ -42,7 +42,7 @@ async def delete_pipeline( """ Deletes one or more existing ingest pipeline. - ``_ + ``_ :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. @@ -91,7 +91,7 @@ async def geo_ip_stats( """ Gets download statistics for GeoIP2 databases used with the geoip processor. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/geoip/stats" @@ -132,7 +132,7 @@ async def get_pipeline( Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline. - ``_ + ``_ :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. @@ -186,7 +186,7 @@ async def processor_grok( you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/processor/grok" @@ -237,7 +237,7 @@ async def put_pipeline( Creates or updates an ingest pipeline. Changes made using this API take effect immediately. - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param description: Description of the ingest pipeline. @@ -323,7 +323,7 @@ async def simulate( """ Executes an ingest pipeline against a set of provided documents. - ``_ + ``_ :param id: Pipeline to test. If you don’t specify a `pipeline` in the request body, this parameter is required. diff --git a/elasticsearch/_async/client/license.py b/elasticsearch/_async/client/license.py index 6a2265446..16e25bdd5 100644 --- a/elasticsearch/_async/client/license.py +++ b/elasticsearch/_async/client/license.py @@ -37,7 +37,7 @@ async def delete( """ Deletes licensing information for the cluster - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license" @@ -76,7 +76,7 @@ async def get( when it expires, for example. For more information about the different types of licenses, see https://www.elastic.co/subscriptions. - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -122,7 +122,7 @@ async def get_basic_status( """ Retrieves information about the status of the basic license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/basic_status" @@ -157,7 +157,7 @@ async def get_trial_status( """ Retrieves information about the status of the trial license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/trial_status" @@ -198,7 +198,7 @@ async def post( """ Updates the license for the cluster. - ``_ + ``_ :param acknowledge: Specifies whether you acknowledge the license changes. :param license: @@ -257,7 +257,7 @@ async def post_start_basic( acknowledge parameter set to true. To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -300,7 +300,7 @@ async def post_start_trial( The start trial API enables you to start a 30-day trial, which gives access to all subscription features. - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/_async/client/logstash.py b/elasticsearch/_async/client/logstash.py index 882a1f633..e2b65680b 100644 --- a/elasticsearch/_async/client/logstash.py +++ b/elasticsearch/_async/client/logstash.py @@ -38,7 +38,7 @@ async def delete_pipeline( """ Deletes a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. """ @@ -78,7 +78,7 @@ async def get_pipeline( """ Retrieves pipelines used for Logstash Central Management. - ``_ + ``_ :param id: Comma-separated list of pipeline identifiers. """ @@ -125,7 +125,7 @@ async def put_pipeline( """ Creates or updates a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. :param pipeline: diff --git a/elasticsearch/_async/client/migration.py b/elasticsearch/_async/client/migration.py index cbfc2c7d2..edc2e3a89 100644 --- a/elasticsearch/_async/client/migration.py +++ b/elasticsearch/_async/client/migration.py @@ -40,7 +40,7 @@ async def deprecations( that use deprecated features that will be removed or changed in the next major version. - ``_ + ``_ :param index: Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. @@ -83,7 +83,7 @@ async def get_feature_upgrade_status( """ Find out whether system features need to be upgraded or not - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" @@ -118,7 +118,7 @@ async def post_feature_upgrade( """ Begin upgrades for system features - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" diff --git a/elasticsearch/_async/client/ml.py b/elasticsearch/_async/client/ml.py index 42cf6df00..9ae1e8da2 100644 --- a/elasticsearch/_async/client/ml.py +++ b/elasticsearch/_async/client/ml.py @@ -42,7 +42,7 @@ async def clear_trained_model_deployment_cache( on that individual node. Calling this API clears the caches without restarting the deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -102,7 +102,7 @@ async def close_job( force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection @@ -163,7 +163,7 @@ async def delete_calendar( """ Removes all scheduled events from a calendar, then deletes it. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -204,7 +204,7 @@ async def delete_calendar_event( """ Deletes scheduled events from a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param event_id: Identifier for the scheduled event. You can obtain this identifier @@ -252,7 +252,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 @@ -301,7 +301,7 @@ async def delete_data_frame_analytics( """ Deletes a data frame analytics job. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param force: If `true`, it deletes a job that is not stopped; this method is @@ -349,7 +349,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 @@ -407,7 +407,7 @@ async def delete_expired_data( expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the , or by omitting the . - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -468,7 +468,7 @@ async def delete_filter( delete the filter. You must update or delete the job before you can delete the filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -514,7 +514,7 @@ async def delete_forecast( parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -586,7 +586,7 @@ async def delete_job( delete datafeed API with the same timeout and force parameters as the delete job request. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param delete_user_annotations: Specifies whether annotations that have been @@ -643,7 +643,7 @@ async def delete_model_snapshot( model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -691,7 +691,7 @@ async def delete_trained_model( 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 @@ -738,7 +738,7 @@ async def delete_trained_model_alias( refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -795,7 +795,7 @@ async def estimate_model_memory( is based on analysis configuration details for the job and cardinality estimates for the fields it references. - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -863,7 +863,7 @@ async def evaluate_data_frame( This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -943,7 +943,7 @@ async def explain_data_frame_analytics( setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -1050,7 +1050,7 @@ async def flush_job( prunes and persists the model state to disk and the job must be opened again before analyzing further data. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -1121,7 +1121,7 @@ async def forecast( occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -1204,7 +1204,7 @@ async def get_buckets( Retrieves anomaly detection job results for one or more buckets. The API presents a chronological view of the records, grouped by bucket. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1299,7 +1299,7 @@ async def get_calendar_events( """ 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 @@ -1365,7 +1365,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 @@ -1438,7 +1438,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. @@ -1522,7 +1522,7 @@ async def get_data_frame_analytics( information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1594,7 +1594,7 @@ async def get_data_frame_analytics_stats( """ 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 @@ -1664,7 +1664,7 @@ async def get_datafeed_stats( datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1724,7 +1724,7 @@ async def get_datafeeds( by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1787,7 +1787,7 @@ async def get_filters( """ Retrieves filters. You can get a single filter or all filters. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1852,7 +1852,7 @@ async def get_influencers( Influencer results are available only if an `influencer_field_name` is specified in the job configuration. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -1933,7 +1933,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 @@ -1994,7 +1994,7 @@ async def get_jobs( for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these @@ -2059,7 +2059,7 @@ async def get_memory_stats( memory, on each node, both within the JVM heap, and natively, outside of the JVM. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -2114,7 +2114,7 @@ async def get_model_snapshot_upgrade_stats( """ Retrieves usage information for anomaly detection job model snapshot upgrades. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2185,7 +2185,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 @@ -2298,7 +2298,7 @@ async def get_overall_buckets( is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. @@ -2403,7 +2403,7 @@ async def get_records( found in each bucket, which relates to the number of time series being modeled and the number of detectors. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2492,7 +2492,7 @@ async def get_trained_models( """ Retrieves configuration information for a trained model. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request @@ -2576,7 +2576,7 @@ async def get_trained_models_stats( for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. @@ -2639,7 +2639,7 @@ async def infer_trained_model( """ Evaluates 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 @@ -2701,7 +2701,7 @@ async def info( It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ml/info" @@ -2746,7 +2746,7 @@ async def open_job( is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2800,7 +2800,7 @@ async def post_calendar_events( """ Adds scheduled events to 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 @@ -2858,7 +2858,7 @@ async def post_data( data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -2921,7 +2921,7 @@ async def preview_data_frame_analytics( """ Previews the extracted features used by a data frame analytics config. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param config: A data frame analytics config as described in create data frame @@ -2991,7 +2991,7 @@ async def preview_datafeed( that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3067,7 +3067,7 @@ async def put_calendar( """ Creates a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -3121,7 +3121,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 @@ -3195,7 +3195,7 @@ async def put_data_frame_analytics( job that performs an analysis on the source indices and stores the outcome in a destination index. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3373,7 +3373,7 @@ async def put_datafeed( directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3528,7 +3528,7 @@ async def put_filter( one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3615,7 +3615,7 @@ async def put_job( Instantiates an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index. - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -3795,7 +3795,7 @@ async def put_trained_model( """ Enables you to supply a trained model that is not created by data frame analytics. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param compressed_definition: The compressed (GZipped and Base64 encoded) inference @@ -3909,7 +3909,7 @@ async def put_trained_model_alias( common between the old and new trained models for the model alias, the API returns a warning. - ``_ + ``_ :param model_id: The identifier for the trained model that the alias refers to. :param model_alias: The alias to create or update. This value cannot end in numbers. @@ -3967,7 +3967,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 @@ -4046,7 +4046,7 @@ async def put_trained_model_vocabulary( processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -4104,7 +4104,7 @@ async def reset_job( job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. - ``_ + ``_ :param job_id: The ID of the job to reset. :param delete_user_annotations: Specifies whether annotations that have been @@ -4164,7 +4164,7 @@ async def revert_model_snapshot( before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -4233,7 +4233,7 @@ async def set_upgrade_mode( jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API. - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -4288,7 +4288,7 @@ async def start_data_frame_analytics( index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4350,7 +4350,7 @@ async def start_datafeed( secondary authorization headers when you created or updated the datafeed, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4420,7 +4420,7 @@ async def start_trained_model_deployment( Starts a trained model deployment, which allocates the model to every machine learning node. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -4504,7 +4504,7 @@ async def stop_data_frame_analytics( Stops one or more data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4571,7 +4571,7 @@ async def stop_datafeed( from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a @@ -4633,7 +4633,7 @@ async def stop_trained_model_deployment( """ Stops 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 @@ -4698,7 +4698,7 @@ async def update_data_frame_analytics( """ Updates an existing 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. @@ -4810,7 +4810,7 @@ async def update_datafeed( the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4973,7 +4973,7 @@ async def update_filter( """ Updates the description of a filter, adds items, or removes items from the list. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -5063,7 +5063,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 @@ -5191,7 +5191,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. @@ -5253,7 +5253,7 @@ async def update_trained_model_deployment( Starts a trained model deployment, which allocates the model to every machine learning node. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -5318,7 +5318,7 @@ async def upgrade_job_snapshot( one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -5394,7 +5394,7 @@ async def validate( """ Validates an anomaly detection job. - ``_ + ``_ :param analysis_config: :param analysis_limits: @@ -5464,7 +5464,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 f9df4013a..c703dcef9 100644 --- a/elasticsearch/_async/client/monitoring.py +++ b/elasticsearch/_async/client/monitoring.py @@ -44,7 +44,7 @@ async def bulk( """ Used by the monitoring features to send monitoring data. - ``_ + ``_ :param interval: Collection interval (e.g., '10s' or '10000ms') of the payload :param operations: diff --git a/elasticsearch/_async/client/nodes.py b/elasticsearch/_async/client/nodes.py index 3a9e0da74..4dc831a9f 100644 --- a/elasticsearch/_async/client/nodes.py +++ b/elasticsearch/_async/client/nodes.py @@ -40,7 +40,7 @@ async def clear_repositories_metering_archive( You can use this API to clear the archived repositories metering information in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -92,7 +92,7 @@ async def get_repositories_metering_info( compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it won’t be present after node restarts. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -148,7 +148,7 @@ async def hot_threads( This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node’s top hot threads. - ``_ + ``_ :param node_id: List of node IDs or names used to limit returned information. :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket @@ -225,7 +225,7 @@ async def info( """ Returns cluster nodes information. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -294,7 +294,7 @@ async def reload_secure_settings( """ Reloads the keystore on nodes in the cluster. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. :param secure_settings_password: The password for the Elasticsearch keystore. @@ -367,7 +367,7 @@ async def stats( """ Returns cluster nodes statistics. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -484,7 +484,7 @@ async def usage( """ Returns information on the usage of features. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting diff --git a/elasticsearch/_async/client/query_rules.py b/elasticsearch/_async/client/query_rules.py index 4a64f8b2d..e6115d9ae 100644 --- a/elasticsearch/_async/client/query_rules.py +++ b/elasticsearch/_async/client/query_rules.py @@ -39,7 +39,7 @@ async def delete_rule( """ Deletes a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to delete @@ -87,7 +87,7 @@ async def delete_ruleset( """ Deletes a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to delete """ @@ -128,7 +128,7 @@ async def get_rule( """ Returns the details about a query rule within a query ruleset - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to retrieve @@ -176,7 +176,7 @@ async def get_ruleset( """ Returns the details about a query ruleset - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset """ @@ -219,7 +219,7 @@ async def list_rulesets( """ Returns summarized information about existing query rulesets. - ``_ + ``_ :param from_: Starting offset (default: 0) :param size: specifies a max number of results to get @@ -269,7 +269,7 @@ async def put_rule( """ Creates or updates a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to be created or updated @@ -339,7 +339,7 @@ async def put_ruleset( """ Creates or updates a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated diff --git a/elasticsearch/_async/client/rollup.py b/elasticsearch/_async/client/rollup.py index 42717380e..d97e4b414 100644 --- a/elasticsearch/_async/client/rollup.py +++ b/elasticsearch/_async/client/rollup.py @@ -38,7 +38,7 @@ async def delete_job( """ Deletes an existing rollup job. - ``_ + ``_ :param id: Identifier for the job. """ @@ -78,7 +78,7 @@ async def get_jobs( """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :param id: Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. @@ -123,7 +123,7 @@ async def get_rollup_caps( Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - ``_ + ``_ :param id: Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. @@ -168,7 +168,7 @@ async def get_rollup_index_caps( Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). - ``_ + ``_ :param index: Data stream or index to check for rollup capabilities. Wildcard (`*`) expressions are supported. @@ -230,7 +230,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. @@ -346,7 +346,7 @@ async def rollup_search( """ Enables searching rolled-up data using the standard Query DSL. - ``_ + ``_ :param index: Enables searching rolled-up data using the standard Query DSL. :param aggregations: Specifies aggregations. @@ -409,7 +409,7 @@ async def start_job( """ Starts an existing, stopped rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. """ @@ -451,7 +451,7 @@ async def stop_job( """ Stops an existing, started rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum) diff --git a/elasticsearch/_async/client/search_application.py b/elasticsearch/_async/client/search_application.py index 73fc36897..42c22b32b 100644 --- a/elasticsearch/_async/client/search_application.py +++ b/elasticsearch/_async/client/search_application.py @@ -38,7 +38,7 @@ async def delete( """ Deletes a search application. - ``_ + ``_ :param name: The name of the search application to delete """ @@ -78,7 +78,7 @@ async def delete_behavioral_analytics( """ Delete a behavioral analytics collection. - ``_ + ``_ :param name: The name of the analytics collection to be deleted """ @@ -118,7 +118,7 @@ async def get( """ Returns the details about a search application - ``_ + ``_ :param name: The name of the search application """ @@ -158,7 +158,7 @@ async def get_behavioral_analytics( """ Returns the existing behavioral analytics collections. - ``_ + ``_ :param name: A list of analytics collections to limit the returned information """ @@ -205,7 +205,7 @@ async def list( """ Returns the existing search applications. - ``_ + ``_ :param from_: Starting offset. :param q: Query in the Lucene query string syntax. @@ -256,7 +256,7 @@ async def put( """ Creates or updates a search application. - ``_ + ``_ :param name: The name of the search application to be created or updated. :param search_application: @@ -309,7 +309,7 @@ async def put_behavioral_analytics( """ Creates a behavioral analytics collection. - ``_ + ``_ :param name: The name of the analytics collection to be created or updated. """ @@ -355,7 +355,7 @@ async def search( """ Perform a search against a search application. - ``_ + ``_ :param name: The name of the search application to be searched. :param params: Query parameters specific to this request, which will override diff --git a/elasticsearch/_async/client/searchable_snapshots.py b/elasticsearch/_async/client/searchable_snapshots.py index 5aac3e3a0..7b57feff8 100644 --- a/elasticsearch/_async/client/searchable_snapshots.py +++ b/elasticsearch/_async/client/searchable_snapshots.py @@ -41,7 +41,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 @@ -99,7 +99,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 @@ -173,7 +173,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 @@ -253,7 +253,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 bb032362c..99cf584c9 100644 --- a/elasticsearch/_async/client/security.py +++ b/elasticsearch/_async/client/security.py @@ -46,7 +46,7 @@ async def activate_user_profile( """ Creates or updates a user profile on behalf of another user. - ``_ + ``_ :param grant_type: :param access_token: @@ -104,7 +104,7 @@ async def authenticate( realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/_authenticate" @@ -148,7 +148,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. @@ -211,7 +211,7 @@ async def clear_api_key_cache( Evicts a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. - ``_ + ``_ :param ids: Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns. @@ -252,7 +252,7 @@ async def clear_cached_privileges( """ Evicts application privileges from the native application privileges cache. - ``_ + ``_ :param application: A comma-separated list of application names """ @@ -294,7 +294,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 @@ -337,7 +337,7 @@ async def clear_cached_roles( """ Evicts roles from the native role cache. - ``_ + ``_ :param name: Role name """ @@ -379,7 +379,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 @@ -442,7 +442,7 @@ async def create_api_key( in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param expiration: Expiration time for the API key. By default, API keys never expire. @@ -514,7 +514,7 @@ async def create_service_token( """ Creates a service accounts token for access without requiring basic authentication. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -584,7 +584,7 @@ async def delete_privileges( """ Removes application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -640,7 +640,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 @@ -688,7 +688,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 @@ -738,7 +738,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 @@ -796,7 +796,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 @@ -844,7 +844,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 @@ -892,7 +892,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 @@ -940,7 +940,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 @@ -988,7 +988,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 @@ -1033,7 +1033,7 @@ async def enroll_kibana( Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/kibana" @@ -1068,7 +1068,7 @@ async def enroll_node( """ Allows a new node to join an existing cluster with security features enabled. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/node" @@ -1114,7 +1114,7 @@ async def get_api_key( `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. - ``_ + ``_ :param active_only: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, @@ -1189,7 +1189,7 @@ async def get_builtin_privileges( Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/privilege/_builtin" @@ -1226,7 +1226,7 @@ async def get_privileges( """ Retrieves application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -1275,7 +1275,7 @@ async def get_role( than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. - ``_ + ``_ :param name: The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about @@ -1320,7 +1320,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 @@ -1368,7 +1368,7 @@ async def get_service_accounts( """ This API returns a list of service accounts that match the provided path parameter(s). - ``_ + ``_ :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 @@ -1419,7 +1419,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. @@ -1485,7 +1485,7 @@ async def get_token( """ Creates a bearer token for access without requiring basic authentication. - ``_ + ``_ :param grant_type: :param kerberos_ticket: @@ -1544,7 +1544,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 @@ -1595,7 +1595,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, @@ -1645,7 +1645,7 @@ async def get_user_profile( """ Retrieves a user's profile using the unique profile ID. - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: List of filters for the `data` field of the profile document. To @@ -1723,7 +1723,7 @@ async def grant_api_key( never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param api_key: Defines the API key. :param grant_type: The type of grant. Supported grant types are: `access_token`, @@ -1804,7 +1804,7 @@ async def has_privileges( """ Determines whether the specified user has a specified list of privileges. - ``_ + ``_ :param user: Username :param application: @@ -1864,7 +1864,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 @@ -1929,7 +1929,7 @@ async def invalidate_api_key( if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field. - ``_ + ``_ :param id: :param ids: A list of API key ids. This parameter cannot be used with any of @@ -2000,7 +2000,7 @@ async def invalidate_token( """ Invalidates one or more access tokens or refresh tokens. - ``_ + ``_ :param realm_name: :param refresh_token: @@ -2060,7 +2060,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 @@ -2142,7 +2142,7 @@ async def put_role( than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -2242,7 +2242,7 @@ async def put_role_mapping( """ Creates and updates role mappings. - ``_ + ``_ :param name: Role-mapping name :param enabled: @@ -2330,7 +2330,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: @@ -2428,7 +2428,7 @@ async def query_api_keys( Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query. - ``_ + ``_ :param aggregations: Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only @@ -2544,7 +2544,7 @@ async def saml_authenticate( """ Submits a SAML Response message to Elasticsearch for consumption. - ``_ + ``_ :param content: The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document. @@ -2606,7 +2606,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. @@ -2672,7 +2672,7 @@ async def saml_invalidate( """ Submits a SAML LogoutRequest message to Elasticsearch for consumption. - ``_ + ``_ :param query_string: The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include @@ -2739,7 +2739,7 @@ async def saml_logout( """ Submits a request to invalidate an access token and refresh token. - ``_ + ``_ :param token: The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received @@ -2797,7 +2797,7 @@ async def saml_prepare_authentication( Creates a SAML authentication request () as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. - ``_ + ``_ :param acs: The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication @@ -2852,7 +2852,7 @@ async def saml_service_provider_metadata( """ Generate SAML metadata for a SAML 2.0 Service Provider. - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -2898,7 +2898,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=` @@ -2982,7 +2982,7 @@ async def update_api_key( an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required. - ``_ + ``_ :param id: The ID of the API key to update. :param expiration: Expiration time for the API key. @@ -3058,7 +3058,7 @@ async def update_user_profile_data( Updates specific data for the user profile that's associated with the specified 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 de8db0291..58524bd71 100644 --- a/elasticsearch/_async/client/slm.py +++ b/elasticsearch/_async/client/slm.py @@ -38,7 +38,7 @@ async def delete_lifecycle( """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove """ @@ -79,7 +79,7 @@ async def execute_lifecycle( Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to be executed """ @@ -118,7 +118,7 @@ async def execute_retention( """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/_execute_retention" @@ -155,7 +155,7 @@ async def get_lifecycle( Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - ``_ + ``_ :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve """ @@ -198,7 +198,7 @@ async def get_stats( Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stats" @@ -233,7 +233,7 @@ async def get_status( """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/status" @@ -281,7 +281,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. @@ -358,7 +358,7 @@ async def start( """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/start" @@ -393,7 +393,7 @@ async def stop( """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stop" diff --git a/elasticsearch/_async/client/snapshot.py b/elasticsearch/_async/client/snapshot.py index 6d2746a85..c0228d0ab 100644 --- a/elasticsearch/_async/client/snapshot.py +++ b/elasticsearch/_async/client/snapshot.py @@ -43,7 +43,7 @@ async def cleanup_repository( Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -99,7 +99,7 @@ async def clone( """ Clones indices from one snapshot into another snapshot in the same repository. - ``_ + ``_ :param repository: A repository name :param snapshot: The name of the snapshot to clone from @@ -184,7 +184,7 @@ async def create( """ Creates a snapshot in a repository. - ``_ + ``_ :param repository: Repository for the snapshot. :param snapshot: Name of the snapshot. Must be unique in the repository. @@ -290,7 +290,7 @@ async def create_repository( """ Creates a repository. - ``_ + ``_ :param name: A repository name :param repository: @@ -352,7 +352,7 @@ async def delete( """ Deletes one or more snapshots. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -405,7 +405,7 @@ async def delete_repository( """ Deletes a repository. - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -473,7 +473,7 @@ async def get( """ Returns information about a snapshot. - ``_ + ``_ :param repository: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. @@ -587,7 +587,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 @@ -666,7 +666,7 @@ async def restore( """ Restores a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -761,7 +761,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 @@ -822,7 +822,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 9dc219c4c..2ed0abb9d 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: Cursor to clear. """ @@ -87,7 +87,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: Identifier for the search. """ @@ -134,7 +134,7 @@ async def get_async( Returns the current status and available results for an async SQL search or stored synchronous SQL search - ``_ + ``_ :param id: Identifier for the search. :param delimiter: Separator for CSV results. The API only supports this parameter @@ -192,7 +192,7 @@ async def get_async_status( Returns the current status of an async SQL search or a stored synchronous SQL search - ``_ + ``_ :param id: Identifier for the search. """ @@ -273,7 +273,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. @@ -383,7 +383,7 @@ async def translate( """ Translates SQL into Elasticsearch queries - ``_ + ``_ :param query: SQL query to run. :param fetch_size: The maximum number of rows (or entries) to return in one response. diff --git a/elasticsearch/_async/client/ssl.py b/elasticsearch/_async/client/ssl.py index 5b9397893..6e8ca281d 100644 --- a/elasticsearch/_async/client/ssl.py +++ b/elasticsearch/_async/client/ssl.py @@ -38,7 +38,7 @@ async def certificates( Retrieves information about the X.509 certificates used to encrypt communications in the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ssl/certificates" diff --git a/elasticsearch/_async/client/synonyms.py b/elasticsearch/_async/client/synonyms.py index 0f6ec9137..ac8c69ce0 100644 --- a/elasticsearch/_async/client/synonyms.py +++ b/elasticsearch/_async/client/synonyms.py @@ -38,7 +38,7 @@ async def delete_synonym( """ Deletes a synonym set - ``_ + ``_ :param id: The id of the synonyms set to be deleted """ @@ -79,7 +79,7 @@ async def delete_synonym_rule( """ Deletes a synonym rule in a synonym set - ``_ + ``_ :param set_id: The id of the synonym set to be updated :param rule_id: The id of the synonym rule to be deleted @@ -129,7 +129,7 @@ async def get_synonym( """ Retrieves a synonym set - ``_ + ``_ :param id: "The id of the synonyms set to be retrieved :param from_: Starting offset for query rules to be retrieved @@ -176,7 +176,7 @@ async def get_synonym_rule( """ Retrieves a synonym rule from a synonym set - ``_ + ``_ :param set_id: The id of the synonym set to retrieve the synonym rule from :param rule_id: The id of the synonym rule to retrieve @@ -225,7 +225,7 @@ async def get_synonyms_sets( """ Retrieves a summary of all defined synonym sets - ``_ + ``_ :param from_: Starting offset :param size: specifies a max number of results to get @@ -272,7 +272,7 @@ async def put_synonym( """ Creates or updates a synonym set. - ``_ + ``_ :param id: The id of the synonyms set to be created or updated :param synonyms_set: The synonym set information to update @@ -325,7 +325,7 @@ async def put_synonym_rule( """ Creates or updates a synonym rule in a synonym set - ``_ + ``_ :param set_id: The id of the synonym set to be updated with the synonym rule :param rule_id: The id of the synonym rule to be updated or created diff --git a/elasticsearch/_async/client/tasks.py b/elasticsearch/_async/client/tasks.py index cf5ebd978..6fe33f155 100644 --- a/elasticsearch/_async/client/tasks.py +++ b/elasticsearch/_async/client/tasks.py @@ -42,7 +42,7 @@ async def cancel( """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :param task_id: ID of the task. :param actions: Comma-separated list or wildcard expression of actions used to @@ -101,7 +101,7 @@ async def get( """ Returns information about a task. - ``_ + ``_ :param task_id: ID of the task. :param timeout: Period to wait for a response. If no response is received before @@ -161,7 +161,7 @@ async def list( The task management API returns information about tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :param actions: Comma-separated list or wildcard expression of actions used to limit the request. diff --git a/elasticsearch/_async/client/text_structure.py b/elasticsearch/_async/client/text_structure.py index fdb018247..67c24eb13 100644 --- a/elasticsearch/_async/client/text_structure.py +++ b/elasticsearch/_async/client/text_structure.py @@ -53,7 +53,7 @@ async def find_structure( Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. - ``_ + ``_ :param text_files: :param charset: The text’s character set. It must be a character set that is @@ -193,7 +193,7 @@ async def test_grok_pattern( """ Tests a Grok pattern on some text. - ``_ + ``_ :param grok_pattern: Grok pattern to run on the text. :param text: Lines of text to run the Grok pattern on. diff --git a/elasticsearch/_async/client/transform.py b/elasticsearch/_async/client/transform.py index 90807b9cf..fd6f64065 100644 --- a/elasticsearch/_async/client/transform.py +++ b/elasticsearch/_async/client/transform.py @@ -41,7 +41,7 @@ async def delete_transform( """ Deletes a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param delete_dest_index: If this value is true, the destination index is deleted @@ -101,7 +101,7 @@ async def get_transform( """ Retrieves configuration information for transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -170,7 +170,7 @@ async def get_transform_stats( """ 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 @@ -254,7 +254,7 @@ async def preview_transform( mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations. - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -390,7 +390,7 @@ async def put_transform( any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -492,7 +492,7 @@ async def reset_transform( use the `force` query parameter. If the destination index was created by the transform, it is deleted. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -543,7 +543,7 @@ async def schedule_now_transform( After _schedule_now API is called, the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime. - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Controls the time to wait for the scheduling to take place @@ -606,7 +606,7 @@ async def start_transform( roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. - ``_ + ``_ :param transform_id: Identifier for the transform. :param from_: Restricts the set of transformed entities to those changed after @@ -660,7 +660,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, @@ -759,7 +759,7 @@ async def update_transform( security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges. - ``_ + ``_ :param transform_id: Identifier for the transform. :param defer_validation: When true, deferrable validations are not run. This @@ -846,7 +846,7 @@ async def upgrade_transforms( the role used to read source data and write to the destination index remains unchanged. - ``_ + ``_ :param dry_run: When true, the request checks for updates but does not run them. :param timeout: Period to wait for a response. If no response is received before diff --git a/elasticsearch/_async/client/watcher.py b/elasticsearch/_async/client/watcher.py index 590f3231c..a0c66f03d 100644 --- a/elasticsearch/_async/client/watcher.py +++ b/elasticsearch/_async/client/watcher.py @@ -39,7 +39,7 @@ async def ack_watch( """ Acknowledges a watch, manually throttling the execution of the watch's actions. - ``_ + ``_ :param watch_id: Watch ID :param action_id: A comma-separated list of the action ids to be acked @@ -90,7 +90,7 @@ async def activate_watch( """ Activates a currently inactive watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -130,7 +130,7 @@ async def deactivate_watch( """ Deactivates a currently active watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -170,7 +170,7 @@ async def delete_watch( """ Removes a watch from Watcher. - ``_ + ``_ :param id: Watch ID """ @@ -243,7 +243,7 @@ async def execute_watch( and control whether a watch record would be written to the watch history after execution. - ``_ + ``_ :param id: Identifier for the watch. :param action_modes: Determines how to handle the watch actions as part of the @@ -326,7 +326,7 @@ async def get_watch( """ Retrieves a watch by its ID. - ``_ + ``_ :param id: Watch ID """ @@ -388,7 +388,7 @@ async def put_watch( """ Creates a new watch, or updates an existing one. - ``_ + ``_ :param id: Watch ID :param actions: @@ -485,7 +485,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. @@ -555,7 +555,7 @@ async def start( """ Starts Watcher if it is not already running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_start" @@ -605,7 +605,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 @@ -651,7 +651,7 @@ async def stop( """ Stops Watcher if it is running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_stop" diff --git a/elasticsearch/_async/client/xpack.py b/elasticsearch/_async/client/xpack.py index 680d831e7..755d517f9 100644 --- a/elasticsearch/_async/client/xpack.py +++ b/elasticsearch/_async/client/xpack.py @@ -43,7 +43,7 @@ async def info( """ Provides general information about the installed X-Pack features. - ``_ + ``_ :param accept_enterprise: If this param is used it must be set to true :param categories: A comma-separated list of the information categories to include @@ -90,7 +90,7 @@ async def usage( This API provides information about which features are currently enabled and available under the current license and some usage statistics. - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and diff --git a/elasticsearch/_sync/client/__init__.py b/elasticsearch/_sync/client/__init__.py index 180f4bc65..449c72d56 100644 --- a/elasticsearch/_sync/client/__init__.py +++ b/elasticsearch/_sync/client/__init__.py @@ -639,7 +639,7 @@ def bulk( Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed. - ``_ + ``_ :param operations: :param index: Name of the data stream, index, or index alias to perform bulk @@ -738,7 +738,7 @@ def clear_scroll( """ Clears the search context and results for a scrolling search. - ``_ + ``_ :param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`. """ @@ -788,7 +788,7 @@ def close_point_in_time( """ Closes a point-in-time. - ``_ + ``_ :param id: The ID of the point-in-time. """ @@ -862,7 +862,7 @@ def count( """ Returns number of documents matching a query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -997,7 +997,7 @@ def create( If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template @@ -1101,7 +1101,7 @@ def delete( """ Removes a JSON document from the specified index. - ``_ + ``_ :param index: Name of the target index. :param id: Unique identifier for the document. @@ -1225,7 +1225,7 @@ def delete_by_query( """ Deletes documents that match the specified query. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -1403,7 +1403,7 @@ def delete_by_query_rethrottle( """ Changes the number of requests per second for a particular Delete By Query operation. - ``_ + ``_ :param task_id: The ID for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -1451,7 +1451,7 @@ def delete_script( """ Deletes a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Period to wait for a connection to the master node. If @@ -1519,7 +1519,7 @@ def exists( """ Checks if a document in an index exists. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1620,7 +1620,7 @@ def exists_source( """ Checks if a document's `_source` is stored. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1721,7 +1721,7 @@ def explain( Returns information about why a specific document matches (or doesn’t match) a query. - ``_ + ``_ :param index: Index names used to limit the request. Only a single index name can be provided to this parameter. @@ -1843,7 +1843,7 @@ def field_caps( like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -1959,7 +1959,7 @@ def get( """ Returns a document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -2050,7 +2050,7 @@ def get_script( """ Retrieves a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. :param master_timeout: Specify timeout for connection to master @@ -2092,7 +2092,7 @@ def get_script_context( """ Returns all script contexts. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_context" @@ -2127,7 +2127,7 @@ def get_script_languages( """ Returns available script types, languages and contexts - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_language" @@ -2182,7 +2182,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. @@ -2265,7 +2265,7 @@ def health_report( """ Returns the health of the cluster. - ``_ + ``_ :param feature: A feature of the cluster, as returned by the top-level health report API. @@ -2342,7 +2342,7 @@ def index( If the target is an index and the document already exists, the request updates the document and increments its version. - ``_ + ``_ :param index: Name of the data stream or index to target. :param document: @@ -2451,7 +2451,7 @@ def info( """ Returns basic information about the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/" @@ -2507,7 +2507,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 @@ -2608,7 +2608,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. @@ -2728,7 +2728,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 @@ -2851,7 +2851,7 @@ def msearch_template( """ Runs multiple templated searches with a single request. - ``_ + ``_ :param search_templates: :param index: Comma-separated list of data streams, indices, and aliases to search. @@ -2946,7 +2946,7 @@ def mtermvectors( """ Returns multiple termvectors in one request. - ``_ + ``_ :param index: Name of the index that contains the documents. :param docs: Array of existing or artificial documents. @@ -3059,7 +3059,7 @@ def open_point_in_time( then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. - ``_ + ``_ :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 @@ -3131,7 +3131,7 @@ def put_script( """ Creates or updates a stored script or search template. - ``_ + ``_ :param id: Identifier for the stored script or search template. Must be unique within the cluster. @@ -3217,7 +3217,7 @@ def rank_eval( Enables you 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. @@ -3313,7 +3313,7 @@ def reindex( source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. - ``_ + ``_ :param dest: The destination you are copying to. :param source: The source you are copying from. @@ -3409,7 +3409,7 @@ def reindex_rethrottle( """ Copies documents from a source to a destination. - ``_ + ``_ :param task_id: Identifier for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -3460,7 +3460,7 @@ def render_search_template( """ Renders a search template as a search request body. - ``_ + ``_ :param id: ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. @@ -3528,7 +3528,7 @@ def scripts_painless_execute( """ Runs a script and returns a result. - ``_ + ``_ :param context: The context that the script should run in. :param context_setup: Additional parameters for the `context`. @@ -3586,7 +3586,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 @@ -3777,7 +3777,7 @@ def search( search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this @@ -4199,7 +4199,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 @@ -4354,7 +4354,7 @@ def search_shards( Returns information about the indices and shards that a search request would be executed against. - ``_ + ``_ :param index: Returns the indices and shards that a search request would be executed against. @@ -4455,7 +4455,7 @@ def search_template( """ Runs a search with a search template. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). @@ -4589,7 +4589,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. @@ -4688,7 +4688,7 @@ def termvectors( Returns information and statistics about terms in the fields of a particular document. - ``_ + ``_ :param index: Name of the index that contains the document. :param id: Unique identifier of the document. @@ -4830,7 +4830,7 @@ def update( """ Updates a document with a script or partial document. - ``_ + ``_ :param index: The name of the index :param id: Document ID @@ -4997,7 +4997,7 @@ def update_by_query( an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this @@ -5190,7 +5190,7 @@ def update_by_query_rethrottle( """ Changes the number of requests per second for a particular Update By Query operation. - ``_ + ``_ :param task_id: The ID for the task. :param requests_per_second: The throttle for this request in sub-requests per diff --git a/elasticsearch/_sync/client/async_search.py b/elasticsearch/_sync/client/async_search.py index 8f53c4042..389712610 100644 --- a/elasticsearch/_sync/client/async_search.py +++ b/elasticsearch/_sync/client/async_search.py @@ -42,7 +42,7 @@ def delete( search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. - ``_ + ``_ :param id: A unique identifier for the async search. """ @@ -90,7 +90,7 @@ def get( results of a specific async search is restricted to the user or API key that submitted it. - ``_ + ``_ :param id: A unique identifier for the async search. :param keep_alive: Specifies how long the async search should be available in @@ -153,7 +153,7 @@ def status( Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. - ``_ + ``_ :param id: A unique identifier for the async search. """ @@ -333,7 +333,7 @@ def submit( response can be set by changing the `search.max_async_search_response_size` cluster level setting. - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_sync/client/autoscaling.py b/elasticsearch/_sync/client/autoscaling.py index 2b2a23fc2..8a7eef03e 100644 --- a/elasticsearch/_sync/client/autoscaling.py +++ b/elasticsearch/_sync/client/autoscaling.py @@ -39,7 +39,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 """ @@ -79,7 +79,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_parts: t.Dict[str, str] = {} __path = "/_autoscaling/capacity" @@ -116,7 +116,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 """ @@ -161,7 +161,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 39d64c8fc..f42fcf0fd 100644 --- a/elasticsearch/_sync/client/cat.py +++ b/elasticsearch/_sync/client/cat.py @@ -59,7 +59,7 @@ def aliases( not intended for use by applications. For application consumption, use the aliases API. - ``_ + ``_ :param name: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. @@ -149,7 +149,7 @@ def allocation( disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. - ``_ + ``_ :param node_id: Comma-separated list of node identifiers or names used to limit the returned information. @@ -237,7 +237,7 @@ def component_templates( using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API. - ``_ + ``_ :param name: The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned. @@ -323,7 +323,7 @@ def count( console. They are not intended for use by applications. For application consumption, use the count API. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -411,7 +411,7 @@ def fielddata( using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. - ``_ + ``_ :param fields: Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. @@ -508,7 +508,7 @@ def health( across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -587,7 +587,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`. @@ -687,7 +687,7 @@ def indices( document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -791,7 +791,7 @@ def master( command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -899,7 +899,7 @@ def ml_data_frame_analytics( console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API. - ``_ + ``_ :param id: The ID of the data frame analytics to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -1023,7 +1023,7 @@ def ml_datafeeds( using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1154,7 +1154,7 @@ def ml_jobs( for use by applications. For application consumption, use the get anomaly detection job statistics API. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param allow_no_match: Specifies what to do when the request: * Contains wildcard @@ -1285,7 +1285,7 @@ def ml_trained_models( command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API. - ``_ + ``_ :param model_id: A unique identifier for the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -1384,7 +1384,7 @@ def nodeattrs( are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1465,7 +1465,7 @@ def nodes( are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param bytes: The unit used to display byte values. :param format: Specifies the format to return the columnar data in, can be set @@ -1552,7 +1552,7 @@ def pending_tasks( console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1628,7 +1628,7 @@ def plugins( They are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1714,7 +1714,7 @@ def recovery( line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -1808,7 +1808,7 @@ def repositories( are not intended for use by applications. For application consumption, use the get snapshot repository API. - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1889,7 +1889,7 @@ def segments( console. They are not intended for use by applications. For application consumption, use the index segments API. - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -1980,7 +1980,7 @@ def shards( for human consumption using the command line or Kibana console. They are not intended for use by applications. - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2070,7 +2070,7 @@ def snapshots( console. They are not intended for use by applications. For application consumption, use the get snapshot API. - ``_ + ``_ :param repository: A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. @@ -2162,7 +2162,7 @@ def tasks( console. They are not intended for use by applications. For application consumption, use the task management API. - ``_ + ``_ :param actions: The task action names, which are used to limit the response. :param detailed: If `true`, the response includes detailed information about @@ -2254,7 +2254,7 @@ def templates( console. They are not intended for use by applications. For application consumption, use the get index template API. - ``_ + ``_ :param name: The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. @@ -2342,7 +2342,7 @@ def thread_pool( They are not intended for use by applications. For application consumption, use the nodes info API. - ``_ + ``_ :param thread_pool_patterns: A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. @@ -2463,7 +2463,7 @@ def transforms( line. They are not intended for use by applications. For application consumption, use the get transform statistics API. - ``_ + ``_ :param transform_id: A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all diff --git a/elasticsearch/_sync/client/ccr.py b/elasticsearch/_sync/client/ccr.py index 69d74827c..407f9be0a 100644 --- a/elasticsearch/_sync/client/ccr.py +++ b/elasticsearch/_sync/client/ccr.py @@ -38,7 +38,7 @@ def delete_auto_follow_pattern( """ Deletes auto-follow patterns. - ``_ + ``_ :param name: The name of the auto follow pattern. """ @@ -113,7 +113,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: @@ -205,7 +205,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 @@ -247,7 +247,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 @@ -300,7 +300,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 @@ -357,7 +357,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. @@ -401,7 +401,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. @@ -443,7 +443,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. @@ -524,7 +524,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 @@ -648,7 +648,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. @@ -717,7 +717,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: @@ -799,7 +799,7 @@ def stats( """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ccr/stats" @@ -836,7 +836,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 961939fc9..d9f7725ce 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. @@ -118,7 +118,7 @@ def delete_component_template( Deletes component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. - ``_ + ``_ :param name: Comma-separated list or wildcard expression of component template names used to limit the request. @@ -168,7 +168,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 @@ -217,7 +217,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. @@ -274,7 +274,7 @@ def get_component_template( """ Retrieves information about component templates. - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -340,7 +340,7 @@ def get_settings( Returns cluster-wide settings. By default, it returns only settings that have been explicitly defined. - ``_ + ``_ :param flat_settings: If `true`, returns settings in flat format. :param include_defaults: If `true`, returns default cluster settings from the @@ -432,7 +432,7 @@ def health( by the worst shard status. The cluster status is controlled by the worst index status. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target @@ -538,7 +538,7 @@ def info( """ Returns different information about the cluster. - ``_ + ``_ :param target: Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. @@ -589,7 +589,7 @@ def pending_tasks( update, the activity of this task might be reported by both task api and pending cluster tasks API. - ``_ + ``_ :param local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. @@ -637,7 +637,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 @@ -713,7 +713,7 @@ def put_component_template( You can include comments anywhere in the request body except before the opening curly bracket. - ``_ + ``_ :param name: Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; @@ -804,7 +804,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 @@ -860,7 +860,7 @@ def remote_info( cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_remote/info" @@ -907,7 +907,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 @@ -998,7 +998,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 @@ -1084,7 +1084,7 @@ def stats( size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). - ``_ + ``_ :param node_id: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. diff --git a/elasticsearch/_sync/client/dangling_indices.py b/elasticsearch/_sync/client/dangling_indices.py index b384e48e5..33dcc7586 100644 --- a/elasticsearch/_sync/client/dangling_indices.py +++ b/elasticsearch/_sync/client/dangling_indices.py @@ -43,7 +43,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 @@ -100,7 +100,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 @@ -151,7 +151,7 @@ def list_dangling_indices( """ Returns all dangling indices. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_dangling" diff --git a/elasticsearch/_sync/client/enrich.py b/elasticsearch/_sync/client/enrich.py index c6bf5f24b..1b6dcadf9 100644 --- a/elasticsearch/_sync/client/enrich.py +++ b/elasticsearch/_sync/client/enrich.py @@ -38,7 +38,7 @@ def delete_policy( """ Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :param name: Enrich policy to delete. """ @@ -79,7 +79,7 @@ def execute_policy( """ Creates the enrich index for an existing enrich policy. - ``_ + ``_ :param name: Enrich policy to execute. :param wait_for_completion: If `true`, the request blocks other enrich policy @@ -123,7 +123,7 @@ def get_policy( """ Returns information about an enrich policy. - ``_ + ``_ :param name: Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. @@ -173,7 +173,7 @@ def put_policy( """ Creates an enrich policy. - ``_ + ``_ :param name: Name of the enrich policy to create or update. :param geo_match: Matches enrich data to incoming documents based on a `geo_shape` @@ -227,7 +227,7 @@ def stats( Returns enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_enrich/_stats" diff --git a/elasticsearch/_sync/client/eql.py b/elasticsearch/_sync/client/eql.py index 4c57f4318..51fa067d9 100644 --- a/elasticsearch/_sync/client/eql.py +++ b/elasticsearch/_sync/client/eql.py @@ -39,7 +39,7 @@ def delete( Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. - ``_ + ``_ :param id: Identifier for the search to delete. A search ID is provided in the EQL search API's response for an async search. A search ID is also provided @@ -86,7 +86,7 @@ def get( Returns the current status and available results for an async EQL search or a stored synchronous EQL search. - ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -137,7 +137,7 @@ def get_status( Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. - ``_ + ``_ :param id: Identifier for the search. """ @@ -225,7 +225,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/esql.py b/elasticsearch/_sync/client/esql.py index f3acd3879..38e5c6950 100644 --- a/elasticsearch/_sync/client/esql.py +++ b/elasticsearch/_sync/client/esql.py @@ -48,7 +48,7 @@ def query( """ Executes an ES|QL request - ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. diff --git a/elasticsearch/_sync/client/features.py b/elasticsearch/_sync/client/features.py index 5d95b3440..40da70e39 100644 --- a/elasticsearch/_sync/client/features.py +++ b/elasticsearch/_sync/client/features.py @@ -38,7 +38,7 @@ def get_features( Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features" @@ -73,7 +73,7 @@ def reset_features( """ Resets the internal state of features, usually by deleting system indices - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_features/_reset" diff --git a/elasticsearch/_sync/client/fleet.py b/elasticsearch/_sync/client/fleet.py index bb6c11b3b..000448b21 100644 --- a/elasticsearch/_sync/client/fleet.py +++ b/elasticsearch/_sync/client/fleet.py @@ -43,7 +43,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 45f4965e6..c8fed47e3 100644 --- a/elasticsearch/_sync/client/graph.py +++ b/elasticsearch/_sync/client/graph.py @@ -48,7 +48,7 @@ def explore( Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. - ``_ + ``_ :param index: Name of the index. :param connections: Specifies or more fields from which you want to extract terms diff --git a/elasticsearch/_sync/client/ilm.py b/elasticsearch/_sync/client/ilm.py index 6884269de..48e389467 100644 --- a/elasticsearch/_sync/client/ilm.py +++ b/elasticsearch/_sync/client/ilm.py @@ -44,7 +44,7 @@ def delete_lifecycle( that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -101,7 +101,7 @@ def explain_lifecycle( currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -165,7 +165,7 @@ def get_lifecycle( """ Retrieves a lifecycle policy. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -216,7 +216,7 @@ def get_status( """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ilm/status" @@ -260,7 +260,7 @@ def migrate_to_data_tiers( data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers. - ``_ + ``_ :param dry_run: If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides @@ -320,7 +320,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: @@ -382,7 +382,7 @@ def put_lifecycle( Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -441,7 +441,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 """ @@ -481,7 +481,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 @@ -525,7 +525,7 @@ def start( """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ :param master_timeout: :param timeout: @@ -572,7 +572,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 d2e5b08d3..2d8385ddd 100644 --- a/elasticsearch/_sync/client/indices.py +++ b/elasticsearch/_sync/client/indices.py @@ -53,7 +53,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) @@ -140,7 +140,7 @@ def analyze( """ Performs analysis on a text string and returns the resulting tokens. - ``_ + ``_ :param index: Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the @@ -242,7 +242,7 @@ def clear_cache( Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -329,7 +329,7 @@ def clone( """ Clones an existing index. - ``_ + ``_ :param index: Name of the source index to clone. :param target: Name of the target index to create. @@ -419,7 +419,7 @@ def close( """ Closes an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -502,7 +502,7 @@ def create( """ Creates a new index. - ``_ + ``_ :param index: Name of the index you wish to create. :param aliases: Aliases for the index. @@ -574,7 +574,7 @@ def create_data_stream( Creates a data stream. You must have a matching index template with data stream enabled. - ``_ + ``_ :param name: Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, @@ -626,7 +626,7 @@ def data_streams_stats( """ Retrieves statistics for one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a @@ -689,7 +689,7 @@ def delete( """ Deletes one or more indices. - ``_ + ``_ :param index: Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. @@ -761,7 +761,7 @@ def delete_alias( """ Removes a data stream or index from an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). @@ -828,7 +828,7 @@ def delete_data_lifecycle( Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle - ``_ + ``_ :param name: A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams @@ -887,7 +887,7 @@ def delete_data_stream( """ Deletes one or more data streams and their backing indices. - ``_ + ``_ :param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. @@ -934,11 +934,12 @@ def delete_index_template( timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None, ) -> ObjectApiResponse[t.Any]: """ - The provided may contain multiple template names separated by - a comma. If multiple template names are specified then there is no wildcard support - and the provided names should match completely with existing templates. + Delete an index template. The provided may contain multiple + template names separated by a comma. If multiple template names are specified + then there is no wildcard support and the provided names should match completely + with existing templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -992,7 +993,7 @@ def delete_template( """ Deletes a legacy index template. - ``_ + ``_ :param name: The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. @@ -1054,7 +1055,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 @@ -1129,7 +1130,7 @@ def downsample( (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. - ``_ + ``_ :param index: Name of the time series index to downsample. :param target_index: Name of the index to create. @@ -1197,7 +1198,7 @@ def exists( """ Checks if a data stream, index, or alias exists. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1275,7 +1276,7 @@ def exists_alias( """ Checks if an alias exists. - ``_ + ``_ :param name: Comma-separated list of aliases to check. Supports wildcards (`*`). :param index: Comma-separated list of data streams or indices used to limit the @@ -1347,7 +1348,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. @@ -1396,9 +1397,10 @@ def exists_template( pretty: t.Optional[bool] = None, ) -> HeadApiResponse: """ - Returns information about whether a particular index template exists. + Check existence of index templates. Returns information about whether a particular + index template exists. - ``_ + ``_ :param name: The comma separated names of the index templates :param flat_settings: Return settings in flat format (default: false) @@ -1453,7 +1455,7 @@ def explain_data_lifecycle( Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. - ``_ + ``_ :param index: The name of the index to explain :param include_defaults: indicates if the API should return the default values @@ -1518,7 +1520,7 @@ def field_usage_stats( """ Returns field usage information for each shard and field of an index. - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1606,7 +1608,7 @@ def flush( """ Flushes one or more data streams or indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this @@ -1689,7 +1691,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 @@ -1787,7 +1789,7 @@ def get( Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -1876,7 +1878,7 @@ def get_alias( """ Retrieves information for one or more aliases. - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, @@ -1957,7 +1959,7 @@ def get_data_lifecycle( """ Retrieves the data stream lifecycle configuration of one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` @@ -2016,7 +2018,7 @@ def get_data_stream( """ Retrieves information about one or more data streams. - ``_ + ``_ :param name: Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are @@ -2083,7 +2085,7 @@ def get_field_mapping( Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. - ``_ + ``_ :param fields: Comma-separated list or wildcard expression of fields used to limit returned information. @@ -2160,9 +2162,9 @@ def get_index_template( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns information about one or more index templates. + Get index templates. Returns information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2238,7 +2240,7 @@ def get_mapping( Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2325,7 +2327,7 @@ def get_settings( Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2412,9 +2414,9 @@ def get_template( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ - Retrieves information about one or more index templates. + Get index templates. Retrieves information about one or more index templates. - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, @@ -2478,7 +2480,7 @@ def migrate_to_data_stream( the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream. - ``_ + ``_ :param name: Name of the index alias to convert to a data stream. """ @@ -2521,7 +2523,7 @@ def modify_data_stream( """ Performs one or more data stream modification actions in a single atomic operation. - ``_ + ``_ :param actions: Actions to perform. """ @@ -2583,7 +2585,7 @@ def open( """ Opens a closed index. For data streams, the API opens any closed backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly @@ -2658,7 +2660,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 """ @@ -2717,7 +2719,7 @@ def put_alias( """ Adds a data stream or index to an alias. - ``_ + ``_ :param index: Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices @@ -2823,7 +2825,7 @@ def put_data_lifecycle( """ Update the data lifecycle of the specified data streams. - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`. @@ -2924,10 +2926,10 @@ def put_index_template( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates an index template. Index templates define settings, mappings, + Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: Index or template name :param allow_auto_create: This setting overrides the value of the `action.auto_create_index` @@ -3090,7 +3092,7 @@ def put_mapping( to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default. - ``_ + ``_ :param index: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. @@ -3222,7 +3224,7 @@ def put_settings( Changes a dynamic index setting in real time. For data streams, index setting changes are applied to all backing indices by default. - ``_ + ``_ :param settings: :param index: Comma-separated list of data streams, indices, and aliases used @@ -3326,10 +3328,10 @@ def put_template( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Creates or updates an index template. Index templates define settings, mappings, + Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -3411,7 +3413,7 @@ def recovery( indices. For data streams, the API returns information for the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3475,7 +3477,7 @@ def refresh( for search. For data streams, the API runs the refresh operation on the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3545,7 +3547,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 @@ -3611,7 +3613,7 @@ def resolve_cluster( including the local cluster, if included. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3683,7 +3685,7 @@ def resolve_index( Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -3747,7 +3749,7 @@ def rollover( """ Creates a new index for a data stream or index alias. - ``_ + ``_ :param alias: Name of the data stream or index alias to roll over. :param new_index: Name of the index to create. Supports date math. Data streams @@ -3853,7 +3855,7 @@ def segments( Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -3933,7 +3935,7 @@ def shard_stores( Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices. - ``_ + ``_ :param index: List of data streams, indices, and aliases used to limit the request. :param allow_no_indices: If false, the request returns an error if any wildcard @@ -4006,7 +4008,7 @@ def shrink( """ Shrinks an existing index into a new index with fewer primary shards. - ``_ + ``_ :param index: Name of the source index to shrink. :param target: Name of the target index to create. @@ -4081,9 +4083,10 @@ def simulate_index_template( pretty: t.Optional[bool] = None, ) -> ObjectApiResponse[t.Any]: """ + Simulate an index. Returns the index configuration that would be applied to the + specified index from an existing index template. - - ``_ + ``_ :param name: Name of the index to simulate :param include_defaults: If true, returns all relevant default configurations @@ -4160,9 +4163,10 @@ def simulate_template( body: t.Optional[t.Dict[str, t.Any]] = None, ) -> ObjectApiResponse[t.Any]: """ - Returns the index configuration that would be applied by a particular index template. + Simulate an index template. Returns the index configuration that would be applied + by a particular index template. - ``_ + ``_ :param name: Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template @@ -4295,7 +4299,7 @@ def split( """ Splits an existing index into a new index with more primary shards. - ``_ + ``_ :param index: Name of the source index to split. :param target: Name of the target index to create. @@ -4388,7 +4392,7 @@ def stats( Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices. - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -4493,7 +4497,7 @@ def unfreeze( """ Unfreezes an index. - ``_ + ``_ :param index: Identifier for the index. :param allow_no_indices: If `false`, the request returns an error if any wildcard @@ -4569,7 +4573,7 @@ def update_aliases( """ Adds a data stream or index to an alias. - ``_ + ``_ :param actions: Actions to perform. :param master_timeout: Period to wait for a connection to the master node. If @@ -4644,7 +4648,7 @@ def validate_query( """ Validates a potentially expensive query without executing it. - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this diff --git a/elasticsearch/_sync/client/inference.py b/elasticsearch/_sync/client/inference.py index be4a9cfb5..bddd684a7 100644 --- a/elasticsearch/_sync/client/inference.py +++ b/elasticsearch/_sync/client/inference.py @@ -46,7 +46,7 @@ def delete( """ Delete an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param task_type: The task type @@ -111,7 +111,7 @@ def get( """ Get an inference endpoint - ``_ + ``_ :param task_type: The task type :param inference_id: The inference Id @@ -174,7 +174,7 @@ def inference( """ Perform inference on the service - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -257,7 +257,7 @@ def put( """ Create an inference endpoint - ``_ + ``_ :param inference_id: The inference Id :param inference_config: diff --git a/elasticsearch/_sync/client/ingest.py b/elasticsearch/_sync/client/ingest.py index ec1d17e4f..079c9ff1c 100644 --- a/elasticsearch/_sync/client/ingest.py +++ b/elasticsearch/_sync/client/ingest.py @@ -42,7 +42,7 @@ def delete_pipeline( """ Deletes one or more existing ingest pipeline. - ``_ + ``_ :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. @@ -91,7 +91,7 @@ def geo_ip_stats( """ Gets download statistics for GeoIP2 databases used with the geoip processor. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/geoip/stats" @@ -132,7 +132,7 @@ def get_pipeline( Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline. - ``_ + ``_ :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. @@ -186,7 +186,7 @@ def processor_grok( you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/processor/grok" @@ -237,7 +237,7 @@ def put_pipeline( Creates or updates an ingest pipeline. Changes made using this API take effect immediately. - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param description: Description of the ingest pipeline. @@ -323,7 +323,7 @@ def simulate( """ Executes an ingest pipeline against a set of provided documents. - ``_ + ``_ :param id: Pipeline to test. If you don’t specify a `pipeline` in the request body, this parameter is required. diff --git a/elasticsearch/_sync/client/license.py b/elasticsearch/_sync/client/license.py index dead68945..2b486cde3 100644 --- a/elasticsearch/_sync/client/license.py +++ b/elasticsearch/_sync/client/license.py @@ -37,7 +37,7 @@ def delete( """ Deletes licensing information for the cluster - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license" @@ -76,7 +76,7 @@ def get( when it expires, for example. For more information about the different types of licenses, see https://www.elastic.co/subscriptions. - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -122,7 +122,7 @@ def get_basic_status( """ Retrieves information about the status of the basic license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/basic_status" @@ -157,7 +157,7 @@ def get_trial_status( """ Retrieves information about the status of the trial license. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/trial_status" @@ -198,7 +198,7 @@ def post( """ Updates the license for the cluster. - ``_ + ``_ :param acknowledge: Specifies whether you acknowledge the license changes. :param license: @@ -257,7 +257,7 @@ def post_start_basic( acknowledge parameter set to true. To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -300,7 +300,7 @@ def post_start_trial( The start trial API enables you to start a 30-day trial, which gives access to all subscription features. - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/_sync/client/logstash.py b/elasticsearch/_sync/client/logstash.py index 040d5e030..8ecbecd90 100644 --- a/elasticsearch/_sync/client/logstash.py +++ b/elasticsearch/_sync/client/logstash.py @@ -38,7 +38,7 @@ def delete_pipeline( """ Deletes a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. """ @@ -78,7 +78,7 @@ def get_pipeline( """ Retrieves pipelines used for Logstash Central Management. - ``_ + ``_ :param id: Comma-separated list of pipeline identifiers. """ @@ -125,7 +125,7 @@ def put_pipeline( """ Creates or updates a pipeline used for Logstash Central Management. - ``_ + ``_ :param id: Identifier for the pipeline. :param pipeline: diff --git a/elasticsearch/_sync/client/migration.py b/elasticsearch/_sync/client/migration.py index b0bfb2f01..f76355538 100644 --- a/elasticsearch/_sync/client/migration.py +++ b/elasticsearch/_sync/client/migration.py @@ -40,7 +40,7 @@ def deprecations( that use deprecated features that will be removed or changed in the next major version. - ``_ + ``_ :param index: Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. @@ -83,7 +83,7 @@ def get_feature_upgrade_status( """ Find out whether system features need to be upgraded or not - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" @@ -118,7 +118,7 @@ def post_feature_upgrade( """ Begin upgrades for system features - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" diff --git a/elasticsearch/_sync/client/ml.py b/elasticsearch/_sync/client/ml.py index 1338e1381..0940c6999 100644 --- a/elasticsearch/_sync/client/ml.py +++ b/elasticsearch/_sync/client/ml.py @@ -42,7 +42,7 @@ def clear_trained_model_deployment_cache( on that individual node. Calling this API clears the caches without restarting the deployment. - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -102,7 +102,7 @@ def close_job( force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection @@ -163,7 +163,7 @@ def delete_calendar( """ Removes all scheduled events from a calendar, then deletes it. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -204,7 +204,7 @@ def delete_calendar_event( """ Deletes scheduled events from a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param event_id: Identifier for the scheduled event. You can obtain this identifier @@ -252,7 +252,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 @@ -301,7 +301,7 @@ def delete_data_frame_analytics( """ Deletes a data frame analytics job. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param force: If `true`, it deletes a job that is not stopped; this method is @@ -349,7 +349,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 @@ -407,7 +407,7 @@ def delete_expired_data( expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the , or by omitting the . - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -468,7 +468,7 @@ def delete_filter( delete the filter. You must update or delete the job before you can delete the filter. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -514,7 +514,7 @@ def delete_forecast( parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -586,7 +586,7 @@ def delete_job( delete datafeed API with the same timeout and force parameters as the delete job request. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param delete_user_annotations: Specifies whether annotations that have been @@ -643,7 +643,7 @@ def delete_model_snapshot( model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -691,7 +691,7 @@ def delete_trained_model( 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 @@ -738,7 +738,7 @@ def delete_trained_model_alias( refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -795,7 +795,7 @@ def estimate_model_memory( is based on analysis configuration details for the job and cardinality estimates for the fields it references. - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -863,7 +863,7 @@ def evaluate_data_frame( This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -943,7 +943,7 @@ def explain_data_frame_analytics( setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -1050,7 +1050,7 @@ def flush_job( prunes and persists the model state to disk and the job must be opened again before analyzing further data. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -1121,7 +1121,7 @@ def forecast( occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -1204,7 +1204,7 @@ def get_buckets( Retrieves anomaly detection job results for one or more buckets. The API presents a chronological view of the records, grouped by bucket. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1299,7 +1299,7 @@ def get_calendar_events( """ 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 @@ -1365,7 +1365,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 @@ -1438,7 +1438,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. @@ -1522,7 +1522,7 @@ def get_data_frame_analytics( information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1594,7 +1594,7 @@ def get_data_frame_analytics_stats( """ 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 @@ -1664,7 +1664,7 @@ def get_datafeed_stats( datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1724,7 +1724,7 @@ def get_datafeeds( by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1787,7 +1787,7 @@ def get_filters( """ Retrieves filters. You can get a single filter or all filters. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1852,7 +1852,7 @@ def get_influencers( Influencer results are available only if an `influencer_field_name` is specified in the job configuration. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -1933,7 +1933,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 @@ -1994,7 +1994,7 @@ def get_jobs( for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these @@ -2059,7 +2059,7 @@ def get_memory_stats( memory, on each node, both within the JVM heap, and natively, outside of the JVM. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -2114,7 +2114,7 @@ def get_model_snapshot_upgrade_stats( """ Retrieves usage information for anomaly detection job model snapshot upgrades. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2185,7 +2185,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 @@ -2298,7 +2298,7 @@ def get_overall_buckets( is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. @@ -2403,7 +2403,7 @@ def get_records( found in each bucket, which relates to the number of time series being modeled and the number of detectors. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2492,7 +2492,7 @@ def get_trained_models( """ Retrieves configuration information for a trained model. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request @@ -2576,7 +2576,7 @@ def get_trained_models_stats( for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. @@ -2639,7 +2639,7 @@ def infer_trained_model( """ Evaluates 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 @@ -2701,7 +2701,7 @@ def info( It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ml/info" @@ -2746,7 +2746,7 @@ def open_job( is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2800,7 +2800,7 @@ def post_calendar_events( """ Adds scheduled events to 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 @@ -2858,7 +2858,7 @@ def post_data( data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -2921,7 +2921,7 @@ def preview_data_frame_analytics( """ Previews the extracted features used by a data frame analytics config. - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param config: A data frame analytics config as described in create data frame @@ -2991,7 +2991,7 @@ def preview_datafeed( that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3067,7 +3067,7 @@ def put_calendar( """ Creates a calendar. - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -3121,7 +3121,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 @@ -3195,7 +3195,7 @@ def put_data_frame_analytics( job that performs an analysis on the source indices and stores the outcome in a destination index. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3373,7 +3373,7 @@ def put_datafeed( directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3528,7 +3528,7 @@ def put_filter( one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3615,7 +3615,7 @@ def put_job( Instantiates an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index. - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -3795,7 +3795,7 @@ def put_trained_model( """ Enables you to supply a trained model that is not created by data frame analytics. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param compressed_definition: The compressed (GZipped and Base64 encoded) inference @@ -3909,7 +3909,7 @@ def put_trained_model_alias( common between the old and new trained models for the model alias, the API returns a warning. - ``_ + ``_ :param model_id: The identifier for the trained model that the alias refers to. :param model_alias: The alias to create or update. This value cannot end in numbers. @@ -3967,7 +3967,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 @@ -4046,7 +4046,7 @@ def put_trained_model_vocabulary( processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -4104,7 +4104,7 @@ def reset_job( job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. - ``_ + ``_ :param job_id: The ID of the job to reset. :param delete_user_annotations: Specifies whether annotations that have been @@ -4164,7 +4164,7 @@ def revert_model_snapshot( before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -4233,7 +4233,7 @@ def set_upgrade_mode( jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API. - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -4288,7 +4288,7 @@ def start_data_frame_analytics( index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4350,7 +4350,7 @@ def start_datafeed( secondary authorization headers when you created or updated the datafeed, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4420,7 +4420,7 @@ def start_trained_model_deployment( Starts a trained model deployment, which allocates the model to every machine learning node. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -4504,7 +4504,7 @@ def stop_data_frame_analytics( Stops one or more data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4571,7 +4571,7 @@ def stop_datafeed( from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a @@ -4633,7 +4633,7 @@ def stop_trained_model_deployment( """ Stops 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 @@ -4698,7 +4698,7 @@ def update_data_frame_analytics( """ Updates an existing 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. @@ -4810,7 +4810,7 @@ def update_datafeed( the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4973,7 +4973,7 @@ def update_filter( """ Updates the description of a filter, adds items, or removes items from the list. - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -5063,7 +5063,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 @@ -5191,7 +5191,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. @@ -5253,7 +5253,7 @@ def update_trained_model_deployment( Starts a trained model deployment, which allocates the model to every machine learning node. - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -5318,7 +5318,7 @@ def upgrade_job_snapshot( one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -5394,7 +5394,7 @@ def validate( """ Validates an anomaly detection job. - ``_ + ``_ :param analysis_config: :param analysis_limits: @@ -5464,7 +5464,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 1fb769658..d7dbeb17e 100644 --- a/elasticsearch/_sync/client/monitoring.py +++ b/elasticsearch/_sync/client/monitoring.py @@ -44,7 +44,7 @@ def bulk( """ Used by the monitoring features to send monitoring data. - ``_ + ``_ :param interval: Collection interval (e.g., '10s' or '10000ms') of the payload :param operations: diff --git a/elasticsearch/_sync/client/nodes.py b/elasticsearch/_sync/client/nodes.py index c55d30c30..64e6a217e 100644 --- a/elasticsearch/_sync/client/nodes.py +++ b/elasticsearch/_sync/client/nodes.py @@ -40,7 +40,7 @@ def clear_repositories_metering_archive( You can use this API to clear the archived repositories metering information in the cluster. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -92,7 +92,7 @@ def get_repositories_metering_info( compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it won’t be present after node restarts. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -148,7 +148,7 @@ def hot_threads( This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node’s top hot threads. - ``_ + ``_ :param node_id: List of node IDs or names used to limit returned information. :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket @@ -225,7 +225,7 @@ def info( """ Returns cluster nodes information. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -294,7 +294,7 @@ def reload_secure_settings( """ Reloads the keystore on nodes in the cluster. - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. :param secure_settings_password: The password for the Elasticsearch keystore. @@ -367,7 +367,7 @@ def stats( """ Returns cluster nodes statistics. - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -484,7 +484,7 @@ def usage( """ Returns information on the usage of features. - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting diff --git a/elasticsearch/_sync/client/query_rules.py b/elasticsearch/_sync/client/query_rules.py index d0ba355c8..f31cff4a9 100644 --- a/elasticsearch/_sync/client/query_rules.py +++ b/elasticsearch/_sync/client/query_rules.py @@ -39,7 +39,7 @@ def delete_rule( """ Deletes a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to delete @@ -87,7 +87,7 @@ def delete_ruleset( """ Deletes a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to delete """ @@ -128,7 +128,7 @@ def get_rule( """ Returns the details about a query rule within a query ruleset - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to retrieve @@ -176,7 +176,7 @@ def get_ruleset( """ Returns the details about a query ruleset - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset """ @@ -219,7 +219,7 @@ def list_rulesets( """ Returns summarized information about existing query rulesets. - ``_ + ``_ :param from_: Starting offset (default: 0) :param size: specifies a max number of results to get @@ -269,7 +269,7 @@ def put_rule( """ Creates or updates a query rule within a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to be created or updated @@ -339,7 +339,7 @@ def put_ruleset( """ Creates or updates a query ruleset. - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated diff --git a/elasticsearch/_sync/client/rollup.py b/elasticsearch/_sync/client/rollup.py index 470fd23b3..5cd5e0eeb 100644 --- a/elasticsearch/_sync/client/rollup.py +++ b/elasticsearch/_sync/client/rollup.py @@ -38,7 +38,7 @@ def delete_job( """ Deletes an existing rollup job. - ``_ + ``_ :param id: Identifier for the job. """ @@ -78,7 +78,7 @@ def get_jobs( """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :param id: Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. @@ -123,7 +123,7 @@ def get_rollup_caps( Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - ``_ + ``_ :param id: Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. @@ -168,7 +168,7 @@ def get_rollup_index_caps( Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). - ``_ + ``_ :param index: Data stream or index to check for rollup capabilities. Wildcard (`*`) expressions are supported. @@ -230,7 +230,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. @@ -346,7 +346,7 @@ def rollup_search( """ Enables searching rolled-up data using the standard Query DSL. - ``_ + ``_ :param index: Enables searching rolled-up data using the standard Query DSL. :param aggregations: Specifies aggregations. @@ -409,7 +409,7 @@ def start_job( """ Starts an existing, stopped rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. """ @@ -451,7 +451,7 @@ def stop_job( """ Stops an existing, started rollup job. - ``_ + ``_ :param id: Identifier for the rollup job. :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum) diff --git a/elasticsearch/_sync/client/search_application.py b/elasticsearch/_sync/client/search_application.py index e6483fe8e..ef7424385 100644 --- a/elasticsearch/_sync/client/search_application.py +++ b/elasticsearch/_sync/client/search_application.py @@ -38,7 +38,7 @@ def delete( """ Deletes a search application. - ``_ + ``_ :param name: The name of the search application to delete """ @@ -78,7 +78,7 @@ def delete_behavioral_analytics( """ Delete a behavioral analytics collection. - ``_ + ``_ :param name: The name of the analytics collection to be deleted """ @@ -118,7 +118,7 @@ def get( """ Returns the details about a search application - ``_ + ``_ :param name: The name of the search application """ @@ -158,7 +158,7 @@ def get_behavioral_analytics( """ Returns the existing behavioral analytics collections. - ``_ + ``_ :param name: A list of analytics collections to limit the returned information """ @@ -205,7 +205,7 @@ def list( """ Returns the existing search applications. - ``_ + ``_ :param from_: Starting offset. :param q: Query in the Lucene query string syntax. @@ -256,7 +256,7 @@ def put( """ Creates or updates a search application. - ``_ + ``_ :param name: The name of the search application to be created or updated. :param search_application: @@ -309,7 +309,7 @@ def put_behavioral_analytics( """ Creates a behavioral analytics collection. - ``_ + ``_ :param name: The name of the analytics collection to be created or updated. """ @@ -355,7 +355,7 @@ def search( """ Perform a search against a search application. - ``_ + ``_ :param name: The name of the search application to be searched. :param params: Query parameters specific to this request, which will override diff --git a/elasticsearch/_sync/client/searchable_snapshots.py b/elasticsearch/_sync/client/searchable_snapshots.py index eefed01da..86e5007ee 100644 --- a/elasticsearch/_sync/client/searchable_snapshots.py +++ b/elasticsearch/_sync/client/searchable_snapshots.py @@ -41,7 +41,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 @@ -99,7 +99,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 @@ -173,7 +173,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 @@ -253,7 +253,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 b4ce94f75..9ab9b5648 100644 --- a/elasticsearch/_sync/client/security.py +++ b/elasticsearch/_sync/client/security.py @@ -46,7 +46,7 @@ def activate_user_profile( """ Creates or updates a user profile on behalf of another user. - ``_ + ``_ :param grant_type: :param access_token: @@ -104,7 +104,7 @@ def authenticate( realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/_authenticate" @@ -148,7 +148,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. @@ -211,7 +211,7 @@ def clear_api_key_cache( Evicts a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. - ``_ + ``_ :param ids: Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns. @@ -252,7 +252,7 @@ def clear_cached_privileges( """ Evicts application privileges from the native application privileges cache. - ``_ + ``_ :param application: A comma-separated list of application names """ @@ -294,7 +294,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 @@ -337,7 +337,7 @@ def clear_cached_roles( """ Evicts roles from the native role cache. - ``_ + ``_ :param name: Role name """ @@ -379,7 +379,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 @@ -442,7 +442,7 @@ def create_api_key( in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param expiration: Expiration time for the API key. By default, API keys never expire. @@ -514,7 +514,7 @@ def create_service_token( """ Creates a service accounts token for access without requiring basic authentication. - ``_ + ``_ :param namespace: An identifier for the namespace :param service: An identifier for the service name @@ -584,7 +584,7 @@ def delete_privileges( """ Removes application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -640,7 +640,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 @@ -688,7 +688,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 @@ -738,7 +738,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 @@ -796,7 +796,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 @@ -844,7 +844,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 @@ -892,7 +892,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 @@ -940,7 +940,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 @@ -988,7 +988,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 @@ -1033,7 +1033,7 @@ def enroll_kibana( Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/kibana" @@ -1068,7 +1068,7 @@ def enroll_node( """ Allows a new node to join an existing cluster with security features enabled. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/node" @@ -1114,7 +1114,7 @@ def get_api_key( `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. - ``_ + ``_ :param active_only: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, @@ -1189,7 +1189,7 @@ def get_builtin_privileges( Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/privilege/_builtin" @@ -1226,7 +1226,7 @@ def get_privileges( """ Retrieves application privileges. - ``_ + ``_ :param application: Application name :param name: Privilege name @@ -1275,7 +1275,7 @@ def get_role( than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. - ``_ + ``_ :param name: The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about @@ -1320,7 +1320,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 @@ -1368,7 +1368,7 @@ def get_service_accounts( """ This API returns a list of service accounts that match the provided path parameter(s). - ``_ + ``_ :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 @@ -1419,7 +1419,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. @@ -1485,7 +1485,7 @@ def get_token( """ Creates a bearer token for access without requiring basic authentication. - ``_ + ``_ :param grant_type: :param kerberos_ticket: @@ -1544,7 +1544,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 @@ -1595,7 +1595,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, @@ -1645,7 +1645,7 @@ def get_user_profile( """ Retrieves a user's profile using the unique profile ID. - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: List of filters for the `data` field of the profile document. To @@ -1723,7 +1723,7 @@ def grant_api_key( never expire. You can specify expiration information when you create the API keys. - ``_ + ``_ :param api_key: Defines the API key. :param grant_type: The type of grant. Supported grant types are: `access_token`, @@ -1804,7 +1804,7 @@ def has_privileges( """ Determines whether the specified user has a specified list of privileges. - ``_ + ``_ :param user: Username :param application: @@ -1864,7 +1864,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 @@ -1929,7 +1929,7 @@ def invalidate_api_key( if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field. - ``_ + ``_ :param id: :param ids: A list of API key ids. This parameter cannot be used with any of @@ -2000,7 +2000,7 @@ def invalidate_token( """ Invalidates one or more access tokens or refresh tokens. - ``_ + ``_ :param realm_name: :param refresh_token: @@ -2060,7 +2060,7 @@ def put_privileges( """ Adds or updates application privileges. - ``_ + ``_ :param privileges: :param refresh: If `true` (the default) then refresh the affected shards to make @@ -2142,7 +2142,7 @@ def put_role( than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -2242,7 +2242,7 @@ def put_role_mapping( """ Creates and updates role mappings. - ``_ + ``_ :param name: Role-mapping name :param enabled: @@ -2330,7 +2330,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: @@ -2428,7 +2428,7 @@ def query_api_keys( Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query. - ``_ + ``_ :param aggregations: Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only @@ -2544,7 +2544,7 @@ def saml_authenticate( """ Submits a SAML Response message to Elasticsearch for consumption. - ``_ + ``_ :param content: The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document. @@ -2606,7 +2606,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. @@ -2672,7 +2672,7 @@ def saml_invalidate( """ Submits a SAML LogoutRequest message to Elasticsearch for consumption. - ``_ + ``_ :param query_string: The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include @@ -2739,7 +2739,7 @@ def saml_logout( """ Submits a request to invalidate an access token and refresh token. - ``_ + ``_ :param token: The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received @@ -2797,7 +2797,7 @@ def saml_prepare_authentication( Creates a SAML authentication request () as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. - ``_ + ``_ :param acs: The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication @@ -2852,7 +2852,7 @@ def saml_service_provider_metadata( """ Generate SAML metadata for a SAML 2.0 Service Provider. - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -2898,7 +2898,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=` @@ -2982,7 +2982,7 @@ def update_api_key( an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required. - ``_ + ``_ :param id: The ID of the API key to update. :param expiration: Expiration time for the API key. @@ -3058,7 +3058,7 @@ def update_user_profile_data( Updates specific data for the user profile that's associated with the specified 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 ed002ed2f..e038ff423 100644 --- a/elasticsearch/_sync/client/slm.py +++ b/elasticsearch/_sync/client/slm.py @@ -38,7 +38,7 @@ def delete_lifecycle( """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove """ @@ -79,7 +79,7 @@ def execute_lifecycle( Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to be executed """ @@ -118,7 +118,7 @@ def execute_retention( """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/_execute_retention" @@ -155,7 +155,7 @@ def get_lifecycle( Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - ``_ + ``_ :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve """ @@ -198,7 +198,7 @@ def get_stats( Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stats" @@ -233,7 +233,7 @@ def get_status( """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/status" @@ -281,7 +281,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. @@ -358,7 +358,7 @@ def start( """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/start" @@ -393,7 +393,7 @@ def stop( """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_slm/stop" diff --git a/elasticsearch/_sync/client/snapshot.py b/elasticsearch/_sync/client/snapshot.py index 80793e366..9a7954354 100644 --- a/elasticsearch/_sync/client/snapshot.py +++ b/elasticsearch/_sync/client/snapshot.py @@ -43,7 +43,7 @@ def cleanup_repository( Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -99,7 +99,7 @@ def clone( """ Clones indices from one snapshot into another snapshot in the same repository. - ``_ + ``_ :param repository: A repository name :param snapshot: The name of the snapshot to clone from @@ -184,7 +184,7 @@ def create( """ Creates a snapshot in a repository. - ``_ + ``_ :param repository: Repository for the snapshot. :param snapshot: Name of the snapshot. Must be unique in the repository. @@ -290,7 +290,7 @@ def create_repository( """ Creates a repository. - ``_ + ``_ :param name: A repository name :param repository: @@ -352,7 +352,7 @@ def delete( """ Deletes one or more snapshots. - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -405,7 +405,7 @@ def delete_repository( """ Deletes a repository. - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -473,7 +473,7 @@ def get( """ Returns information about a snapshot. - ``_ + ``_ :param repository: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. @@ -587,7 +587,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 @@ -666,7 +666,7 @@ def restore( """ Restores a snapshot. - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -761,7 +761,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 @@ -822,7 +822,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 ea25c4c25..786d42864 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: Cursor to clear. """ @@ -87,7 +87,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: Identifier for the search. """ @@ -134,7 +134,7 @@ def get_async( Returns the current status and available results for an async SQL search or stored synchronous SQL search - ``_ + ``_ :param id: Identifier for the search. :param delimiter: Separator for CSV results. The API only supports this parameter @@ -192,7 +192,7 @@ def get_async_status( Returns the current status of an async SQL search or a stored synchronous SQL search - ``_ + ``_ :param id: Identifier for the search. """ @@ -273,7 +273,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. @@ -383,7 +383,7 @@ def translate( """ Translates SQL into Elasticsearch queries - ``_ + ``_ :param query: SQL query to run. :param fetch_size: The maximum number of rows (or entries) to return in one response. diff --git a/elasticsearch/_sync/client/ssl.py b/elasticsearch/_sync/client/ssl.py index 19892748e..a0eadee74 100644 --- a/elasticsearch/_sync/client/ssl.py +++ b/elasticsearch/_sync/client/ssl.py @@ -38,7 +38,7 @@ def certificates( Retrieves information about the X.509 certificates used to encrypt communications in the cluster. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ssl/certificates" diff --git a/elasticsearch/_sync/client/synonyms.py b/elasticsearch/_sync/client/synonyms.py index 2455c3f3d..9a045c25e 100644 --- a/elasticsearch/_sync/client/synonyms.py +++ b/elasticsearch/_sync/client/synonyms.py @@ -38,7 +38,7 @@ def delete_synonym( """ Deletes a synonym set - ``_ + ``_ :param id: The id of the synonyms set to be deleted """ @@ -79,7 +79,7 @@ def delete_synonym_rule( """ Deletes a synonym rule in a synonym set - ``_ + ``_ :param set_id: The id of the synonym set to be updated :param rule_id: The id of the synonym rule to be deleted @@ -129,7 +129,7 @@ def get_synonym( """ Retrieves a synonym set - ``_ + ``_ :param id: "The id of the synonyms set to be retrieved :param from_: Starting offset for query rules to be retrieved @@ -176,7 +176,7 @@ def get_synonym_rule( """ Retrieves a synonym rule from a synonym set - ``_ + ``_ :param set_id: The id of the synonym set to retrieve the synonym rule from :param rule_id: The id of the synonym rule to retrieve @@ -225,7 +225,7 @@ def get_synonyms_sets( """ Retrieves a summary of all defined synonym sets - ``_ + ``_ :param from_: Starting offset :param size: specifies a max number of results to get @@ -272,7 +272,7 @@ def put_synonym( """ Creates or updates a synonym set. - ``_ + ``_ :param id: The id of the synonyms set to be created or updated :param synonyms_set: The synonym set information to update @@ -325,7 +325,7 @@ def put_synonym_rule( """ Creates or updates a synonym rule in a synonym set - ``_ + ``_ :param set_id: The id of the synonym set to be updated with the synonym rule :param rule_id: The id of the synonym rule to be updated or created diff --git a/elasticsearch/_sync/client/tasks.py b/elasticsearch/_sync/client/tasks.py index 4db15d817..352813539 100644 --- a/elasticsearch/_sync/client/tasks.py +++ b/elasticsearch/_sync/client/tasks.py @@ -42,7 +42,7 @@ def cancel( """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :param task_id: ID of the task. :param actions: Comma-separated list or wildcard expression of actions used to @@ -101,7 +101,7 @@ def get( """ Returns information about a task. - ``_ + ``_ :param task_id: ID of the task. :param timeout: Period to wait for a response. If no response is received before @@ -161,7 +161,7 @@ def list( The task management API returns information about tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :param actions: Comma-separated list or wildcard expression of actions used to limit the request. diff --git a/elasticsearch/_sync/client/text_structure.py b/elasticsearch/_sync/client/text_structure.py index a7c30711e..0b0ad1d4e 100644 --- a/elasticsearch/_sync/client/text_structure.py +++ b/elasticsearch/_sync/client/text_structure.py @@ -53,7 +53,7 @@ def find_structure( Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. - ``_ + ``_ :param text_files: :param charset: The text’s character set. It must be a character set that is @@ -193,7 +193,7 @@ def test_grok_pattern( """ Tests a Grok pattern on some text. - ``_ + ``_ :param grok_pattern: Grok pattern to run on the text. :param text: Lines of text to run the Grok pattern on. diff --git a/elasticsearch/_sync/client/transform.py b/elasticsearch/_sync/client/transform.py index 6eac80a30..0e95cf913 100644 --- a/elasticsearch/_sync/client/transform.py +++ b/elasticsearch/_sync/client/transform.py @@ -41,7 +41,7 @@ def delete_transform( """ Deletes a transform. - ``_ + ``_ :param transform_id: Identifier for the transform. :param delete_dest_index: If this value is true, the destination index is deleted @@ -101,7 +101,7 @@ def get_transform( """ Retrieves configuration information for transforms. - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -170,7 +170,7 @@ def get_transform_stats( """ 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 @@ -254,7 +254,7 @@ def preview_transform( mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations. - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -390,7 +390,7 @@ def put_transform( any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -492,7 +492,7 @@ def reset_transform( use the `force` query parameter. If the destination index was created by the transform, it is deleted. - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -543,7 +543,7 @@ def schedule_now_transform( After _schedule_now API is called, the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime. - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Controls the time to wait for the scheduling to take place @@ -606,7 +606,7 @@ def start_transform( roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. - ``_ + ``_ :param transform_id: Identifier for the transform. :param from_: Restricts the set of transformed entities to those changed after @@ -660,7 +660,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, @@ -759,7 +759,7 @@ def update_transform( security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges. - ``_ + ``_ :param transform_id: Identifier for the transform. :param defer_validation: When true, deferrable validations are not run. This @@ -846,7 +846,7 @@ def upgrade_transforms( the role used to read source data and write to the destination index remains unchanged. - ``_ + ``_ :param dry_run: When true, the request checks for updates but does not run them. :param timeout: Period to wait for a response. If no response is received before diff --git a/elasticsearch/_sync/client/watcher.py b/elasticsearch/_sync/client/watcher.py index 7fa2f2603..fc66a12b9 100644 --- a/elasticsearch/_sync/client/watcher.py +++ b/elasticsearch/_sync/client/watcher.py @@ -39,7 +39,7 @@ def ack_watch( """ Acknowledges a watch, manually throttling the execution of the watch's actions. - ``_ + ``_ :param watch_id: Watch ID :param action_id: A comma-separated list of the action ids to be acked @@ -90,7 +90,7 @@ def activate_watch( """ Activates a currently inactive watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -130,7 +130,7 @@ def deactivate_watch( """ Deactivates a currently active watch. - ``_ + ``_ :param watch_id: Watch ID """ @@ -170,7 +170,7 @@ def delete_watch( """ Removes a watch from Watcher. - ``_ + ``_ :param id: Watch ID """ @@ -243,7 +243,7 @@ def execute_watch( and control whether a watch record would be written to the watch history after execution. - ``_ + ``_ :param id: Identifier for the watch. :param action_modes: Determines how to handle the watch actions as part of the @@ -326,7 +326,7 @@ def get_watch( """ Retrieves a watch by its ID. - ``_ + ``_ :param id: Watch ID """ @@ -388,7 +388,7 @@ def put_watch( """ Creates a new watch, or updates an existing one. - ``_ + ``_ :param id: Watch ID :param actions: @@ -485,7 +485,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. @@ -555,7 +555,7 @@ def start( """ Starts Watcher if it is not already running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_start" @@ -605,7 +605,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 @@ -651,7 +651,7 @@ def stop( """ Stops Watcher if it is running. - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_watcher/_stop" diff --git a/elasticsearch/_sync/client/xpack.py b/elasticsearch/_sync/client/xpack.py index 29bd2a040..9da3b8548 100644 --- a/elasticsearch/_sync/client/xpack.py +++ b/elasticsearch/_sync/client/xpack.py @@ -43,7 +43,7 @@ def info( """ Provides general information about the installed X-Pack features. - ``_ + ``_ :param accept_enterprise: If this param is used it must be set to true :param categories: A comma-separated list of the information categories to include @@ -90,7 +90,7 @@ def usage( This API provides information about which features are currently enabled and available under the current license and some usage statistics. - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and