actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[7.x] Document all APIs, add stability warning

Browse Source
This commit is contained in:
Seth Michael Larson
2020-10-28 13:49:05 -05:00
committed by GitHub
parent c1fbdef75e
commit d08860a357
24 changed files with 696 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files
elasticsearch/client/__init__.py
+20
View File
@@ -1340,6 +1340,11 @@ class Elasticsearch(object):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-rank-eval.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg body: The ranking evaluation search definition, including
search requests, document ratings and ranking metric definition.
:arg index: A comma-separated list of index names to search; use
@@ -1459,6 +1464,11 @@ class Elasticsearch(object):
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg body: The script to execute
"""
return self.transport.perform_request(
@@ -2050,6 +2060,11 @@ class Elasticsearch(object):
Returns all script contexts.
`<https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
"""
return self.transport.perform_request(
"GET", "/_script_context", params=params, headers=headers
@@ -2061,6 +2076,11 @@ class Elasticsearch(object):
Returns available script types, languages and contexts
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-scripting.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
"""
return self.transport.perform_request(
"GET", "/_script_language", params=params, headers=headers
elasticsearch/client/autoscaling.py
+32 -12
View File
@@ -19,18 +19,6 @@ from .utils import NamespacedClient, query_params, SKIP_IN_PATH, _make_path
class AutoscalingClient(NamespacedClient):
@query_params()
def get_autoscaling_decision(self, params=None, headers=None):
"""
Gets the current autoscaling decision based on the configured autoscaling
policy, indicating whether or not autoscaling is needed.
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-get-autoscaling-decision.html>`_
"""
return self.transport.perform_request(
"GET", "/_autoscaling/decision", params=params, headers=headers
)
@query_params()
def delete_autoscaling_policy(self, name, params=None, headers=None):
"""
@@ -38,6 +26,11 @@ class AutoscalingClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-delete-autoscaling-policy.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: the name of the autoscaling policy
"""
if name in SKIP_IN_PATH:
@@ -57,6 +50,11 @@ class AutoscalingClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-get-autoscaling-policy.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: the name of the autoscaling policy
"""
if name in SKIP_IN_PATH:
@@ -76,6 +74,11 @@ class AutoscalingClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-put-autoscaling-policy.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: the name of the autoscaling policy
:arg body: the specification of the autoscaling policy
"""
@@ -90,3 +93,20 @@ class AutoscalingClient(NamespacedClient):
headers=headers,
body=body,
)
@query_params()
def get_autoscaling_capacity(self, params=None, headers=None):
"""
Gets the current autoscaling capacity based on the configured autoscaling
policy.
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-get-autoscaling-capacity.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
"""
return self.transport.perform_request(
"GET", "/_autoscaling/capacity", params=params, headers=headers
)
elasticsearch/client/autoscaling.pyi
+14 -14
View File
@@ -19,20 +19,6 @@ from typing import Any, MutableMapping, Optional, Union, Collection
from .utils import NamespacedClient
class AutoscalingClient(NamespacedClient):
def get_autoscaling_decision(
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...
) -> Any: ...
def delete_autoscaling_policy(
self,
name: Any,
@@ -79,3 +65,17 @@ class AutoscalingClient(NamespacedClient):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...
) -> Any: ...
def get_autoscaling_capacity(
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...
) -> Any: ...
elasticsearch/client/cluster.py
+20
View File
@@ -268,6 +268,11 @@ class ClusterClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-component-template.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The name of the template
:arg master_timeout: Specify timeout for connection to master
:arg timeout: Explicit operation timeout
@@ -289,6 +294,11 @@ class ClusterClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-component-template.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The comma separated names of the component templates
:arg local: Return local information, do not retrieve the state
from master node (default: false)
@@ -309,6 +319,11 @@ class ClusterClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-component-template.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The name of the template
:arg body: The template definition
:arg create: Whether the index template should only be added if
@@ -335,6 +350,11 @@ class ClusterClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-component-template.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The name of the template
:arg local: Return local information, do not retrieve the state
from master node (default: false)
elasticsearch/client/eql.py
+15
View File
@@ -26,6 +26,11 @@ class EqlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg index: The name of the index to scope the operation
:arg body: Eql request body. Use the `query` to limit the query
scope.
@@ -57,6 +62,11 @@ class EqlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The async search ID
"""
if id in SKIP_IN_PATH:
@@ -74,6 +84,11 @@ class EqlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The async search ID
:arg keep_alive: Update the time interval in which the results
(partial or final) for this search will be available Default: 5d
elasticsearch/client/indices.py
+35
View File
@@ -1368,6 +1368,11 @@ class IndicesClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The name of the template
:arg master_timeout: Specify timeout for connection to master
:arg timeout: Explicit operation timeout
@@ -1389,6 +1394,11 @@ class IndicesClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The name of the template
:arg flat_settings: Return settings in flat format (default:
false)
@@ -1411,6 +1421,11 @@ class IndicesClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The comma separated names of the index templates
:arg flat_settings: Return settings in flat format (default:
false)
@@ -1430,6 +1445,11 @@ class IndicesClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The name of the template
:arg body: The template definition
:arg cause: User defined reason for creating/updating the index
@@ -1458,6 +1478,11 @@ class IndicesClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: The name of the index (it must be a concrete index
name)
:arg body: New index template definition, which will be included
@@ -1501,6 +1526,11 @@ class IndicesClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg body: New index template definition to be simulated, if no
index template name is specified
:arg name: The name of the index template
@@ -1526,6 +1556,11 @@ class IndicesClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-resolve-index-api.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg name: A comma-separated list of names or wildcard
expressions
:arg expand_wildcards: Whether wildcard expressions should get
elasticsearch/client/ml.py
+70
View File
@@ -270,6 +270,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-find-file-structure.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg body: The contents of the file to be analyzed
:arg charset: Optional parameter to specify the character set of
the file
@@ -1290,6 +1295,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The ID of the data frame analytics to delete
:arg force: True if the job should be forcefully deleted
:arg timeout: Controls the time to wait until a job is deleted.
@@ -1312,6 +1322,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/evaluate-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg body: The evaluation definition
"""
if body in SKIP_IN_PATH:
@@ -1332,6 +1347,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The ID of the data frame analytics to fetch
:arg allow_no_match: Whether to ignore if a wildcard expression
matches no data frame analytics. (This includes `_all` string or when no
@@ -1360,6 +1380,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-dfanalytics-stats.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The ID of the data frame analytics stats to fetch
:arg allow_no_match: Whether to ignore if a wildcard expression
matches no data frame analytics. (This includes `_all` string or when no
@@ -1387,6 +1412,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The ID of the data frame analytics to create
:arg body: The data frame analytics configuration
"""
@@ -1409,6 +1439,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/start-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The ID of the data frame analytics to start
:arg body: The start data frame analytics parameters
:arg timeout: Controls the time to wait until the task has
@@ -1432,6 +1467,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/stop-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The ID of the data frame analytics to stop
:arg body: The stop data frame analytics parameters
:arg allow_no_match: Whether to ignore if a wildcard expression
@@ -1461,6 +1501,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-trained-models.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg model_id: The ID of the trained model to delete
"""
if model_id in SKIP_IN_PATH:
@@ -1482,6 +1527,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/explain-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg body: The data frame analytics config to explain
:arg id: The ID of the data frame analytics to explain
"""
@@ -1509,6 +1559,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-trained-models.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg model_id: The ID of the trained models to fetch
:arg allow_no_match: Whether to ignore if a wildcard expression
matches no trained models. (This includes `_all` string or when no
@@ -1548,6 +1603,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-trained-models-stats.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg model_id: The ID of the trained models stats to fetch
:arg allow_no_match: Whether to ignore if a wildcard expression
matches no trained models. (This includes `_all` string or when no
@@ -1574,6 +1634,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-trained-models.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg model_id: The ID of the trained models to store
:arg body: The trained model configuration
"""
@@ -1617,6 +1682,11 @@ class MlClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/update-dfanalytics.html>`_
.. warning::
This API is **beta** so may include breaking changes
or be removed in a future version
:arg id: The ID of the data frame analytics to update
:arg body: The data frame analytics settings to update
"""
elasticsearch/client/monitoring.py
+5
View File
@@ -26,6 +26,11 @@ class MonitoringClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/monitor-elasticsearch-cluster.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg body: The operation definition and data (action-data
pairs), separated by newlines
:arg doc_type: Default document type for items which don't
elasticsearch/client/rollup.py
+40
View File
@@ -26,6 +26,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-delete-job.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg id: The ID of the job to delete
"""
if id in SKIP_IN_PATH:
@@ -42,6 +47,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-get-job.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg id: The ID of the job(s) to fetch. Accepts glob patterns,
or left blank for all jobs
"""
@@ -57,6 +67,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-get-rollup-caps.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg id: The ID of the index to check rollup capabilities on, or
left blank for all jobs
"""
@@ -72,6 +87,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-get-rollup-index-caps.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg index: The rollup index or index pattern to obtain rollup
capabilities from.
"""
@@ -89,6 +109,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-put-job.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg id: The ID of the job to create
:arg body: The job configuration
"""
@@ -111,6 +136,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-search.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg index: The indices or index-pattern(s) (containing rollup
or regular data) that should be searched
:arg body: The search request body
@@ -139,6 +169,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-start-job.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg id: The ID of the job to start
"""
if id in SKIP_IN_PATH:
@@ -158,6 +193,11 @@ class RollupClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-stop-job.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg id: The ID of the job to stop
:arg timeout: Block for (at maximum) the specified duration
while waiting for the job to stop. Defaults to 30s.
elasticsearch/client/searchable_snapshots.py
+20
View File
@@ -26,6 +26,11 @@ class SearchableSnapshotsClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg index: A comma-separated list of index name to limit the
operation
:arg allow_no_indices: Whether to ignore if a wildcard indices
@@ -51,6 +56,11 @@ class SearchableSnapshotsClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-api-mount-snapshot.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg repository: The name of the repository containing the
snapshot of the index to mount
:arg snapshot: The name of the snapshot of the index to mount
@@ -80,6 +90,11 @@ class SearchableSnapshotsClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg repository: The repository for which to get the stats for
"""
if repository in SKIP_IN_PATH:
@@ -99,6 +114,11 @@ class SearchableSnapshotsClient(NamespacedClient):
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html>`_
.. warning::
This API is **experimental** so may include breaking changes
or be removed in a future version
:arg index: A comma-separated list of index names
"""
return self.transport.perform_request(