.. autoclass:: es_client.builder.ClientArgs :members: :undoc-members: :private-members:
.. autoclass:: es_client.builder.OtherArgs :members: :undoc-members: :private-members:
.. autoclass:: es_client.builder.Builder :members: :undoc-members: :private-members:
client: | The :py:class:`~.elasticsearch.Elasticsearch` object is only created after passing all
other tests, and if autoconnect is True , or
:py:meth:`~.es_client.builder.Builder.connect` has been called. |
---|---|
is_master: | Initially set to None , this value is set automatically if autoconnect is
True . It can otherwise be set by calling
:py:meth:`~.es_client.builder.Builder._find_master` after
:py:meth:`~.es_client.builder.Builder._get_client` has been called first. |
Check to see if
elasticsearch
key is in the suppliedraw_config
dictionary. Log a warning about using defaults if it is not.Run :py:meth:`~.es_client.builder.Builder._check_config` on
raw_config
Set instance attributes
version_max
andversion_min
with the provided values.Set instance attribute
master_only
to the value fromraw_config
Initialize instance attribute
is_master
with aNone
Set instance attribute
skip_version_test
to the value fromraw_config
Set instance attribute
client_args
to the value ofraw_config['elasticsearch']['client']
Execute :py:meth:`~.es_client.builder.Builder._check_basic_auth` to build the
basic_auth
tuple, ifusername
andpassword
are notNone
.Execute :py:meth:`~.es_client.builder.Builder._check_api_key` to build the
api_key
tuple, if theid
andapi_key
sub-keys are notNone
.Execute :py:meth:`~.es_client.builder.Builder._check_cloud_id` to ensure the client connects to the defined
cloud_id
rather than anything inhosts
.Execute :py:meth:`~.es_client.builder.Builder._check_ssl` to ensure we have at least the certifi signing certificates.
If
autoconnect
is True:- Execute :py:meth:`~.es_client.builder.Builder._get_client` to finally build the :py:class:`~.elasticsearch.Elasticsearch` client object.
- Execute :py:meth:`~.es_client.builder.Builder._check_version` and
:py:meth:`~.es_client.builder.Builder._check_master` as post-checks. Nothing will
happen if these checks are not enabled in
raw_config