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

All Implemented Interfaces:

Closeable, AutoCloseable

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
CacheStatsResponse	cacheStats()	Get cache statistics.
CacheStatsResponse	cacheStats(CacheStatsRequest request)	Get cache statistics.
final CacheStatsResponse	cacheStats(Function<CacheStatsRequest.Builder,ObjectBuilder<CacheStatsRequest>> fn)	Get cache statistics.
ClearCacheResponse	clearCache()	Clear the cache.
ClearCacheResponse	clearCache(ClearCacheRequest request)	Clear the cache.
final ClearCacheResponse	clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clear the cache.
MountResponse	mount(MountRequest request)	Mount a snapshot.
final MountResponse	mount(Function<MountRequest.Builder,ObjectBuilder<MountRequest>> fn)	Mount a snapshot.
SearchableSnapshotsStatsResponse	stats()	Get searchable snapshot statistics.
SearchableSnapshotsStatsResponse	stats(SearchableSnapshotsStatsRequest request)	Get searchable snapshot statistics.
final SearchableSnapshotsStatsResponse	stats(Function<SearchableSnapshotsStatsRequest.Builder,ObjectBuilder<SearchableSnapshotsStatsRequest>> fn)	Get searchable snapshot statistics.
ElasticsearchSearchableSnapshotsClient	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

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>

cacheStats

public CacheStatsResponse cacheStats(CacheStatsRequest request)
                              throws IOException,
ElasticsearchException

Get cache statistics. Get statistics about the shared cache for partially mounted indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

cacheStats

public final CacheStatsResponse cacheStats(Function<CacheStatsRequest.Builder,ObjectBuilder<CacheStatsRequest>> fn)
                                    throws IOException,
ElasticsearchException

Get cache statistics. Get statistics about the shared cache for partially mounted indices.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

cacheStats

public CacheStatsResponse cacheStats()
                              throws IOException,
ElasticsearchException

Get cache statistics. Get statistics about the shared cache for partially mounted indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCache

public ClearCacheResponse clearCache(ClearCacheRequest request)
                              throws IOException,
ElasticsearchException

Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCache

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

Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCache

public ClearCacheResponse clearCache()
                              throws IOException,
ElasticsearchException

Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mount

public MountResponse mount(MountRequest request)
                    throws IOException,
ElasticsearchException

Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mount

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

Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public SearchableSnapshotsStatsResponse stats(SearchableSnapshotsStatsRequest request)
                                       throws IOException,
ElasticsearchException

Get searchable snapshot statistics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

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

Get searchable snapshot statistics.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public SearchableSnapshotsStatsResponse stats()
                                       throws IOException,
ElasticsearchException

Get searchable snapshot statistics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co