[7.x] Document 'UnsupportedProductError'

This commit is contained in:
Seth Michael Larson
2021-07-20 11:58:32 -05:00
parent d381491482
commit 023cf5380f
4 changed files with 12 additions and 8 deletions
+1
View File
@@ -23,3 +23,4 @@ Exceptions
.. autoclass:: RequestError(TransportError)
.. autoclass:: AuthenticationException(TransportError)
.. autoclass:: AuthorizationException(TransportError)
.. autoclass:: UnsupportedProductError
+8 -8
View File
@@ -26,21 +26,21 @@ Product check on first request
Starting in v7.14.0 the client performs a required product check before
the first API call is executed. This product check allows the client to
establish that it's communicating with a valid Elasticsearch cluster.
establish that it's communicating with a supported Elasticsearch cluster.
The product check requires a single HTTP request to the ``info`` API. In
most cases this request will succeed quickly and then no further product
check HTTP requests will be sent.
The product check will verify that the ``X-Elastic-Product: Elasticsearch``
HTTP header is being sent or if the ``info`` API response has proper values
of ``tagline`` and ``version.build_flavor``.
HTTP header is being sent or if the ``info`` API indicates a supported
distribution of Elasticsearch.
If the client detects that it's not connected to Elasticsearch the
``NotElasticsearchError`` exception will be raised. In previous versions
of Elasticsearch the ``info`` API required additional permissions so
if an authentication or authorization error is raised during the
product check then an ``ElasticsearchWarning`` is raised and the client
If the client detects that it's not connected to a supported distribution of
Elasticsearch the ``UnsupportedProductError`` exception will be raised.
In previous versions of Elasticsearch the ``info`` API required additional
permissions so if an authentication or authorization error is raised during
the product check then an ``ElasticsearchWarning`` is raised and the client
proceeds normally.
.. py:module:: elasticsearch.connection