Package co.elastic.clients.elasticsearch.searchable_snapshots

Class ElasticsearchSearchableSnapshotsClient

java.lang.Object

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

co.elastic.clients.elasticsearch.searchable_snapshots.ElasticsearchSearchableSnapshotsClient

public class ElasticsearchSearchableSnapshotsClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSearchableSnapshotsClient>

Client for the searchable_snapshots namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ClearCacheResponse	clearCache()	Clear the cache of searchable snapshots.
ClearCacheResponse	clearCache(ClearCacheRequest request)	Clear the cache of searchable snapshots.
ClearCacheResponse	clearCache(java.util.function.Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clear the cache of searchable snapshots.
MountResponse	mount(MountRequest request)	Mount a snapshot as a searchable index.
MountResponse	mount(java.util.function.Function<MountRequest.Builder,ObjectBuilder<MountRequest>> fn)	Mount a snapshot as a searchable index.
SearchableSnapshotsStatsResponse	stats()	Retrieve shard-level statistics about searchable snapshots.
SearchableSnapshotsStatsResponse	stats(SearchableSnapshotsStatsRequest request)	Retrieve shard-level statistics about searchable snapshots.
SearchableSnapshotsStatsResponse	stats(java.util.function.Function<SearchableSnapshotsStatsRequest.Builder,ObjectBuilder<SearchableSnapshotsStatsRequest>> fn)	Retrieve shard-level statistics about searchable snapshots.
ElasticsearchSearchableSnapshotsClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchSearchableSnapshotsClient

public ElasticsearchSearchableSnapshotsClient(ElasticsearchTransport transport)

ElasticsearchSearchableSnapshotsClient

public ElasticsearchSearchableSnapshotsClient(ElasticsearchTransport transport,
@Nullable
TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSearchableSnapshotsClient withTransportOptions(@Nullable
TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSearchableSnapshotsClient>

clearCache

public ClearCacheResponse clearCache(ClearCacheRequest request)
                              throws java.io.IOException,
ElasticsearchException

Clear the cache of searchable snapshots.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

clearCache

public final ClearCacheResponse clearCache(java.util.function.Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)
                                    throws java.io.IOException,
ElasticsearchException

Clear the cache of searchable snapshots.

Parameters:

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

clearCache

public ClearCacheResponse clearCache()
                              throws java.io.IOException,
ElasticsearchException

Clear the cache of searchable snapshots.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

mount

public MountResponse mount(MountRequest request)
                    throws java.io.IOException,
ElasticsearchException

Mount a snapshot as a searchable index.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

mount

public final MountResponse mount(java.util.function.Function<MountRequest.Builder,ObjectBuilder<MountRequest>> fn)
                          throws java.io.IOException,
ElasticsearchException

Mount a snapshot as a searchable index.

Parameters:

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stats

public SearchableSnapshotsStatsResponse stats(SearchableSnapshotsStatsRequest request)
                                       throws java.io.IOException,
ElasticsearchException

Retrieve shard-level statistics about searchable snapshots.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stats

public final SearchableSnapshotsStatsResponse stats(java.util.function.Function<SearchableSnapshotsStatsRequest.Builder,ObjectBuilder<SearchableSnapshotsStatsRequest>> fn)
                                             throws java.io.IOException,
ElasticsearchException

Retrieve shard-level statistics about searchable snapshots.

Parameters:

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stats

public SearchableSnapshotsStatsResponse stats()
                                       throws java.io.IOException,
ElasticsearchException

Retrieve shard-level statistics about searchable snapshots.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co