ES Client API reference

Builder Class

class es_client.builder.Builder(configdict: Dict | None = None, configfile: str | None = None, autoconnect: bool = False)

Parameters:

• configdict – A configuration dictionary

• configfile – A YAML configuration file

• autoconnect – Connect to client automatically

Build a client connection object out of settings from configfile or configdict.

If neither configfile nor configdict is provided, empty defaults will be used.

If both are provided, configdict will be used, and configfile ignored.

attributes

The DotMap storage for attributes and settings

client

The Elasticsearch client connection object

property client_args: DotMap

The storage and workspace for client settings

Getter:

Get client values

Setter:

Set client values

Type:

DotMap

property config: DotMap

Configuration settings extracted from configfile or configdict

Getter:

Get the configuration settings

Setter:

Set the configuration settings

Type:

DotMap

connect() → None

Attempt connection and do post-connection checks

property is_master: bool

Is the node we connected to the elected master?

Getter:

Get the “Are we the elected master?” state

Setter:

Set the “Are we the elected master?” state

Type:

bool

property master_only: bool

Only allow connection to the elected master, if True

Getter:

Get the “Only use the elected master?” state

Setter:

Set the “Only use the elected master?” state

Type:

bool

property other_args: DotMap

The storage and workspace for other_settings

Getter:

Get other_args values

Setter:

Set other_args values

Type:

DotMap

process_config_opts(configdict: Dict | None, configfile: str | None) → None

Process whether to use a configdict or configfile

set_client_defaults() → None

Set defaults for the client_args property

set_other_defaults() → None

Set defaults for the other_args property

property skip_version_test: bool

Getter:

Get the skip_version_test value

Setter:

Set the skip_version_test value

Type:

bool

test_connection() → ObjectApiResponse[Any]

Connect and execute Elasticsearch.info()

update_config() → None

Update object with values provided

validate() → None

Validate that what has been supplied is acceptable to attempt a connection

property version_max: Tuple

Getter:

Get the maximum acceptable Elasticsearch version

Setter:

Set the maximum acceptable Elasticsearch version

Type:

t.Tuple

property version_min: Tuple

Getter:

Get the minimum acceptable Elasticsearch version

Setter:

Set the minimum acceptable Elasticsearch version

Type:

t.Tuple

Builder Attribute Errata

client:

The Elasticsearch object is only created after passing all other tests, and if autoconnect is True, or 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 _find_master() after _get_client() has been called first.

Class Instantiation Flow

1. Check to see if elasticsearch key is in the supplied raw_config dictionary. Log a warning about using defaults if it is not.

2. Run _check_config() on raw_config

3. Set instance attributes version_max and version_min with the provided values.

4. Set instance attribute master_only to the value from raw_config

5. Initialize instance attribute is_master with a None

6. Set instance attribute skip_version_test to the value from raw_config

7. Set instance attribute client_args to the value of raw_config['elasticsearch']['client']

8. Execute _check_basic_auth() to build the basic_auth tuple, if username and password are not None.

9. Execute _check_api_key() to build the api_key tuple, if the id and api_key sub-keys are not None.

10. Execute _check_cloud_id() to ensure the client connects to the defined cloud_id rather than anything in hosts.

11. Execute _check_ssl() to ensure we have at least the certifi signing certificates.

12. If autoconnect is True:

    1. Execute _get_client() to finally build the Elasticsearch client object.

    2. Execute _check_version() and _check_master() as post-checks. Nothing will happen if these checks are not enabled in raw_config