Package co.elastic.clients.elasticsearch.streams

Class ElasticsearchStreamsClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchStreamsClient>

co.elastic.clients.elasticsearch.streams.ElasticsearchStreamsClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchStreamsClient
extends ApiClient<ElasticsearchTransport,ElasticsearchStreamsClient>

Client for the streams namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchStreamsClient(ElasticsearchTransport transport)
ElasticsearchStreamsClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
LogsDisableResponse	logsDisable(LogsDisableRequest request)	Disable a named stream.
final LogsDisableResponse	logsDisable(Function<LogsDisableRequest.Builder,ObjectBuilder<LogsDisableRequest>> fn)	Disable a named stream.
LogsEnableResponse	logsEnable(LogsEnableRequest request)	Enable a named stream.
final LogsEnableResponse	logsEnable(Function<LogsEnableRequest.Builder,ObjectBuilder<LogsEnableRequest>> fn)	Enable a named stream.
StreamsStatusResponse	status()	Get the status of streams.
StreamsStatusResponse	status(StreamsStatusRequest request)	Get the status of streams.
final StreamsStatusResponse	status(Function<StreamsStatusRequest.Builder,ObjectBuilder<StreamsStatusRequest>> fn)	Get the status of streams.
ElasticsearchStreamsClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElasticsearchStreamsClient

public ElasticsearchStreamsClient(ElasticsearchTransport transport)

ElasticsearchStreamsClient

public ElasticsearchStreamsClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchStreamsClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchStreamsClient>

logsDisable

public LogsDisableResponse logsDisable(LogsDisableRequest request)
                                throws IOException,
ElasticsearchException

Disable a named stream.

Turn off the named stream feature for this cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

logsDisable

public final LogsDisableResponse logsDisable(Function<LogsDisableRequest.Builder,ObjectBuilder<LogsDisableRequest>> fn)
                                      throws IOException,
ElasticsearchException

Disable a named stream.

Turn off the named stream feature for this cluster.

Parameters:

fn - a function that initializes a builder to create the LogsDisableRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

logsEnable

public LogsEnableResponse logsEnable(LogsEnableRequest request)
                              throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

logsEnable

public final LogsEnableResponse logsEnable(Function<LogsEnableRequest.Builder,ObjectBuilder<LogsEnableRequest>> fn)
                                    throws IOException,
ElasticsearchException

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.

Parameters:

fn - a function that initializes a builder to create the LogsEnableRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public StreamsStatusResponse status(StreamsStatusRequest request)
                             throws IOException,
ElasticsearchException

Get the status of streams.

Get the current status for all types of streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public final StreamsStatusResponse status(Function<StreamsStatusRequest.Builder,ObjectBuilder<StreamsStatusRequest>> fn)
                                   throws IOException,
ElasticsearchException

Get the status of streams.

Get the current status for all types of streams.

Parameters:

fn - a function that initializes a builder to create the StreamsStatusRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public StreamsStatusResponse status()
                             throws IOException,
ElasticsearchException

Get the status of streams.

Get the current status for all types of streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co