Streams

class elasticsearch.client.StreamsClient

To use this client, access client.streams from an Elasticsearch client. For example:

from elasticsearch import Elasticsearch

# Create the client instance
client = Elasticsearch(...)
# Use the streams client
client.streams.<method>(...)
logs_disable(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

Disable a named stream.

Turn off the named stream feature for this cluster.

https://www.elastic.co/docs/api/doc/elasticsearch#TODO

Parameters:

  • name (str | Literal['logs', 'logs.ecs', 'logs.otel']) – The stream type to disable.

  • master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  • timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

logs_enable(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

Enable a named stream.

Turn on the named stream feature for this cluster.

NOTE: To protect existing data, this feature can be turned on only if the cluster does not have existing indices or data streams that match the pattern <name>|<name>.* for the enabled stream type name. If those indices or data streams exist, a 409 - Conflict response and error is returned.

https://www.elastic.co/docs/api/doc/elasticsearch#TODO

Parameters:

  • name (str | Literal['logs', 'logs.ecs', 'logs.otel']) – The stream type to enable.

  • master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  • timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

status(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

Get the status of streams.

Get the current status for all types of streams.

https://www.elastic.co/docs/api/doc/elasticsearch#TODO

Parameters:

  • master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any]