Package co.elastic.clients.elasticsearch.searchable_snapshots

Class ElasticsearchSearchableSnapshotsAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.searchable_snapshots.ElasticsearchSearchableSnapshotsAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSearchableSnapshotsAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSearchableSnapshotsAsyncClient>

Client for the searchable_snapshots namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

ElasticsearchSearchableSnapshotsAsyncClient

public ElasticsearchSearchableSnapshotsAsyncClient(ElasticsearchTransport transport)

ElasticsearchSearchableSnapshotsAsyncClient

public ElasticsearchSearchableSnapshotsAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSearchableSnapshotsAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSearchableSnapshotsAsyncClient>

cacheStats

public CompletableFuture<CacheStatsResponse> cacheStats(CacheStatsRequest request)

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

See Also:

• Documentation on elastic.co

cacheStats

public final CompletableFuture<CacheStatsResponse> cacheStats(Function<CacheStatsRequest.Builder,ObjectBuilder<CacheStatsRequest>> fn)

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

See Also:

• Documentation on elastic.co

cacheStats

public CompletableFuture<CacheStatsResponse> cacheStats()

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

See Also:

• Documentation on elastic.co

clearCache

public CompletableFuture<ClearCacheResponse> clearCache(ClearCacheRequest request)

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

See Also:

• Documentation on elastic.co

clearCache

public final CompletableFuture<ClearCacheResponse> clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)

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

See Also:

• Documentation on elastic.co

clearCache

public CompletableFuture<ClearCacheResponse> clearCache()

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

See Also:

• Documentation on elastic.co

mount

public CompletableFuture<MountResponse> mount(MountRequest request)

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.

See Also:

• Documentation on elastic.co

mount

public final CompletableFuture<MountResponse> mount(Function<MountRequest.Builder,ObjectBuilder<MountRequest>> fn)

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<SearchableSnapshotsStatsResponse> stats(SearchableSnapshotsStatsRequest request)

Get searchable snapshot statistics.

See Also:

• Documentation on elastic.co

stats

public final CompletableFuture<SearchableSnapshotsStatsResponse> stats(Function<SearchableSnapshotsStatsRequest.Builder,ObjectBuilder<SearchableSnapshotsStatsRequest>> fn)

Get searchable snapshot statistics.

Parameters:

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<SearchableSnapshotsStatsResponse> stats()

Get searchable snapshot statistics.

See Also:

• Documentation on elastic.co