Package co.elastic.clients.elasticsearch.indices

Class ElasticsearchIndicesAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.indices.ElasticsearchIndicesAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchIndicesAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchIndicesAsyncClient>

Client for the indices namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AddBlockResponse>	addBlock(AddBlockRequest request)	Add an index block.
final CompletableFuture<AddBlockResponse>	addBlock(Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)	Add an index block.
CompletableFuture<AnalyzeResponse>	analyze()	Get tokens from text analysis.
CompletableFuture<AnalyzeResponse>	analyze(AnalyzeRequest request)	Get tokens from text analysis.
final CompletableFuture<AnalyzeResponse>	analyze(Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)	Get tokens from text analysis.
CompletableFuture<ClearCacheResponse>	clearCache()	Clears the caches of one or more indices.
CompletableFuture<ClearCacheResponse>	clearCache(ClearCacheRequest request)	Clears the caches of one or more indices.
final CompletableFuture<ClearCacheResponse>	clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clears the caches of one or more indices.
CompletableFuture<CloneIndexResponse>	clone(CloneIndexRequest request)	Clones an existing index.
final CompletableFuture<CloneIndexResponse>	clone(Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)	Clones an existing index.
CompletableFuture<CloseIndexResponse>	close(CloseIndexRequest request)	Closes an index.
final CompletableFuture<CloseIndexResponse>	close(Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)	Closes an index.
CompletableFuture<CreateIndexResponse>	create(CreateIndexRequest request)	Create an index.
final CompletableFuture<CreateIndexResponse>	create(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)	Create an index.
CompletableFuture<CreateDataStreamResponse>	createDataStream(CreateDataStreamRequest request)	Create a data stream.
final CompletableFuture<CreateDataStreamResponse>	createDataStream(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)	Create a data stream.
CompletableFuture<DataStreamsStatsResponse>	dataStreamsStats()	Get data stream stats.
CompletableFuture<DataStreamsStatsResponse>	dataStreamsStats(DataStreamsStatsRequest request)	Get data stream stats.
final CompletableFuture<DataStreamsStatsResponse>	dataStreamsStats(Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)	Get data stream stats.
CompletableFuture<DeleteIndexResponse>	delete(DeleteIndexRequest request)	Delete indices.
final CompletableFuture<DeleteIndexResponse>	delete(Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)	Delete indices.
CompletableFuture<DeleteAliasResponse>	deleteAlias(DeleteAliasRequest request)	Delete an alias.
final CompletableFuture<DeleteAliasResponse>	deleteAlias(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)	Delete an alias.
CompletableFuture<DeleteDataLifecycleResponse>	deleteDataLifecycle(DeleteDataLifecycleRequest request)	Delete data stream lifecycles.
final CompletableFuture<DeleteDataLifecycleResponse>	deleteDataLifecycle(Function<DeleteDataLifecycleRequest.Builder,ObjectBuilder<DeleteDataLifecycleRequest>> fn)	Delete data stream lifecycles.
CompletableFuture<DeleteDataStreamResponse>	deleteDataStream(DeleteDataStreamRequest request)	Delete data streams.
final CompletableFuture<DeleteDataStreamResponse>	deleteDataStream(Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)	Delete data streams.
CompletableFuture<DeleteIndexTemplateResponse>	deleteIndexTemplate(DeleteIndexTemplateRequest request)	Delete an index template.
final CompletableFuture<DeleteIndexTemplateResponse>	deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)	Delete an index template.
CompletableFuture<DeleteTemplateResponse>	deleteTemplate(DeleteTemplateRequest request)	Deletes a legacy index template.
final CompletableFuture<DeleteTemplateResponse>	deleteTemplate(Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)	Deletes a legacy index template.
CompletableFuture<DiskUsageResponse>	diskUsage(DiskUsageRequest request)	Analyzes the disk usage of each field of an index or data stream.
final CompletableFuture<DiskUsageResponse>	diskUsage(Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> fn)	Analyzes the disk usage of each field of an index or data stream.
CompletableFuture<DownsampleResponse>	downsample(DownsampleRequest request)	Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.
final CompletableFuture<DownsampleResponse>	downsample(Function<DownsampleRequest.Builder,ObjectBuilder<DownsampleRequest>> fn)	Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.
CompletableFuture<BooleanResponse>	exists(ExistsRequest request)	Check indices.
final CompletableFuture<BooleanResponse>	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Check indices.
CompletableFuture<BooleanResponse>	existsAlias(ExistsAliasRequest request)	Check aliases.
final CompletableFuture<BooleanResponse>	existsAlias(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)	Check aliases.
CompletableFuture<BooleanResponse>	existsIndexTemplate(ExistsIndexTemplateRequest request)	Returns information about whether a particular index template exists.
final CompletableFuture<BooleanResponse>	existsIndexTemplate(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)	Returns information about whether a particular index template exists.
CompletableFuture<BooleanResponse>	existsTemplate(ExistsTemplateRequest request)	Check existence of index templates.
final CompletableFuture<BooleanResponse>	existsTemplate(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)	Check existence of index templates.
CompletableFuture<ExplainDataLifecycleResponse>	explainDataLifecycle(ExplainDataLifecycleRequest request)	Get the status for a data stream lifecycle.
final CompletableFuture<ExplainDataLifecycleResponse>	explainDataLifecycle(Function<ExplainDataLifecycleRequest.Builder,ObjectBuilder<ExplainDataLifecycleRequest>> fn)	Get the status for a data stream lifecycle.
CompletableFuture<FieldUsageStatsResponse>	fieldUsageStats(FieldUsageStatsRequest request)	Returns field usage information for each shard and field of an index.
final CompletableFuture<FieldUsageStatsResponse>	fieldUsageStats(Function<FieldUsageStatsRequest.Builder,ObjectBuilder<FieldUsageStatsRequest>> fn)	Returns field usage information for each shard and field of an index.
CompletableFuture<FlushResponse>	flush()	Flushes one or more data streams or indices.
CompletableFuture<FlushResponse>	flush(FlushRequest request)	Flushes one or more data streams or indices.
final CompletableFuture<FlushResponse>	flush(Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)	Flushes one or more data streams or indices.
CompletableFuture<ForcemergeResponse>	forcemerge()	Performs the force merge operation on one or more indices.
CompletableFuture<ForcemergeResponse>	forcemerge(ForcemergeRequest request)	Performs the force merge operation on one or more indices.
final CompletableFuture<ForcemergeResponse>	forcemerge(Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)	Performs the force merge operation on one or more indices.
CompletableFuture<GetIndexResponse>	get(GetIndexRequest request)	Get index information.
final CompletableFuture<GetIndexResponse>	get(Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)	Get index information.
CompletableFuture<GetAliasResponse>	getAlias()	Get aliases.
CompletableFuture<GetAliasResponse>	getAlias(GetAliasRequest request)	Get aliases.
final CompletableFuture<GetAliasResponse>	getAlias(Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)	Get aliases.
CompletableFuture<GetDataLifecycleResponse>	getDataLifecycle(GetDataLifecycleRequest request)	Get data stream lifecycles.
final CompletableFuture<GetDataLifecycleResponse>	getDataLifecycle(Function<GetDataLifecycleRequest.Builder,ObjectBuilder<GetDataLifecycleRequest>> fn)	Get data stream lifecycles.
CompletableFuture<GetDataStreamResponse>	getDataStream()	Get data streams.
CompletableFuture<GetDataStreamResponse>	getDataStream(GetDataStreamRequest request)	Get data streams.
final CompletableFuture<GetDataStreamResponse>	getDataStream(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)	Get data streams.
CompletableFuture<GetFieldMappingResponse>	getFieldMapping(GetFieldMappingRequest request)	Get mapping definitions.
final CompletableFuture<GetFieldMappingResponse>	getFieldMapping(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)	Get mapping definitions.
CompletableFuture<GetIndexTemplateResponse>	getIndexTemplate()	Get index templates.
CompletableFuture<GetIndexTemplateResponse>	getIndexTemplate(GetIndexTemplateRequest request)	Get index templates.
final CompletableFuture<GetIndexTemplateResponse>	getIndexTemplate(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)	Get index templates.
CompletableFuture<GetMappingResponse>	getMapping()	Get mapping definitions.
CompletableFuture<GetMappingResponse>	getMapping(GetMappingRequest request)	Get mapping definitions.
final CompletableFuture<GetMappingResponse>	getMapping(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)	Get mapping definitions.
CompletableFuture<GetIndicesSettingsResponse>	getSettings()	Get index settings.
CompletableFuture<GetIndicesSettingsResponse>	getSettings(GetIndicesSettingsRequest request)	Get index settings.
final CompletableFuture<GetIndicesSettingsResponse>	getSettings(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)	Get index settings.
CompletableFuture<GetTemplateResponse>	getTemplate()	Get index templates.
CompletableFuture<GetTemplateResponse>	getTemplate(GetTemplateRequest request)	Get index templates.
final CompletableFuture<GetTemplateResponse>	getTemplate(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)	Get index templates.
CompletableFuture<MigrateToDataStreamResponse>	migrateToDataStream(MigrateToDataStreamRequest request)	Convert an index alias to a data stream.
final CompletableFuture<MigrateToDataStreamResponse>	migrateToDataStream(Function<MigrateToDataStreamRequest.Builder,ObjectBuilder<MigrateToDataStreamRequest>> fn)	Convert an index alias to a data stream.
CompletableFuture<ModifyDataStreamResponse>	modifyDataStream(ModifyDataStreamRequest request)	Update data streams.
final CompletableFuture<ModifyDataStreamResponse>	modifyDataStream(Function<ModifyDataStreamRequest.Builder,ObjectBuilder<ModifyDataStreamRequest>> fn)	Update data streams.
CompletableFuture<OpenResponse>	open(OpenRequest request)	Opens a closed index.
final CompletableFuture<OpenResponse>	open(Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)	Opens a closed index.
CompletableFuture<PromoteDataStreamResponse>	promoteDataStream(PromoteDataStreamRequest request)	Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
final CompletableFuture<PromoteDataStreamResponse>	promoteDataStream(Function<PromoteDataStreamRequest.Builder,ObjectBuilder<PromoteDataStreamRequest>> fn)	Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
CompletableFuture<PutAliasResponse>	putAlias(PutAliasRequest request)	Create or update an alias.
final CompletableFuture<PutAliasResponse>	putAlias(Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)	Create or update an alias.
CompletableFuture<PutDataLifecycleResponse>	putDataLifecycle(PutDataLifecycleRequest request)	Update data stream lifecycles.
final CompletableFuture<PutDataLifecycleResponse>	putDataLifecycle(Function<PutDataLifecycleRequest.Builder,ObjectBuilder<PutDataLifecycleRequest>> fn)	Update data stream lifecycles.
CompletableFuture<PutIndexTemplateResponse>	putIndexTemplate(PutIndexTemplateRequest request)	Create or update an index template.
final CompletableFuture<PutIndexTemplateResponse>	putIndexTemplate(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)	Create or update an index template.
CompletableFuture<PutMappingResponse>	putMapping(PutMappingRequest request)	Update field mappings.
final CompletableFuture<PutMappingResponse>	putMapping(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)	Update field mappings.
CompletableFuture<PutIndicesSettingsResponse>	putSettings()	Update index settings.
CompletableFuture<PutIndicesSettingsResponse>	putSettings(PutIndicesSettingsRequest request)	Update index settings.
final CompletableFuture<PutIndicesSettingsResponse>	putSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)	Update index settings.
CompletableFuture<PutTemplateResponse>	putTemplate(PutTemplateRequest request)	Create or update an index template.
final CompletableFuture<PutTemplateResponse>	putTemplate(Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)	Create or update an index template.
CompletableFuture<RecoveryResponse>	recovery()	Returns information about ongoing and completed shard recoveries for one or more indices.
CompletableFuture<RecoveryResponse>	recovery(RecoveryRequest request)	Returns information about ongoing and completed shard recoveries for one or more indices.
final CompletableFuture<RecoveryResponse>	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about ongoing and completed shard recoveries for one or more indices.
CompletableFuture<RefreshResponse>	refresh()	Refresh an index.
CompletableFuture<RefreshResponse>	refresh(RefreshRequest request)	Refresh an index.
final CompletableFuture<RefreshResponse>	refresh(Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)	Refresh an index.
CompletableFuture<ReloadSearchAnalyzersResponse>	reloadSearchAnalyzers(ReloadSearchAnalyzersRequest request)	Reloads an index's search analyzers and their resources.
final CompletableFuture<ReloadSearchAnalyzersResponse>	reloadSearchAnalyzers(Function<ReloadSearchAnalyzersRequest.Builder,ObjectBuilder<ReloadSearchAnalyzersRequest>> fn)	Reloads an index's search analyzers and their resources.
CompletableFuture<ResolveClusterResponse>	resolveCluster(ResolveClusterRequest request)	Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
final CompletableFuture<ResolveClusterResponse>	resolveCluster(Function<ResolveClusterRequest.Builder,ObjectBuilder<ResolveClusterRequest>> fn)	Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
CompletableFuture<ResolveIndexResponse>	resolveIndex(ResolveIndexRequest request)	Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
final CompletableFuture<ResolveIndexResponse>	resolveIndex(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)	Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
CompletableFuture<RolloverResponse>	rollover(RolloverRequest request)	Roll over to a new index.
final CompletableFuture<RolloverResponse>	rollover(Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)	Roll over to a new index.
CompletableFuture<SegmentsResponse>	segments()	Returns low-level information about the Lucene segments in index shards.
CompletableFuture<SegmentsResponse>	segments(SegmentsRequest request)	Returns low-level information about the Lucene segments in index shards.
final CompletableFuture<SegmentsResponse>	segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Returns low-level information about the Lucene segments in index shards.
CompletableFuture<ShardStoresResponse>	shardStores()	Retrieves store information about replica shards in one or more indices.
CompletableFuture<ShardStoresResponse>	shardStores(ShardStoresRequest request)	Retrieves store information about replica shards in one or more indices.
final CompletableFuture<ShardStoresResponse>	shardStores(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)	Retrieves store information about replica shards in one or more indices.
CompletableFuture<ShrinkResponse>	shrink(ShrinkRequest request)	Shrinks an existing index into a new index with fewer primary shards.
final CompletableFuture<ShrinkResponse>	shrink(Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)	Shrinks an existing index into a new index with fewer primary shards.
CompletableFuture<SimulateIndexTemplateResponse>	simulateIndexTemplate(SimulateIndexTemplateRequest request)	Simulate an index.
final CompletableFuture<SimulateIndexTemplateResponse>	simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)	Simulate an index.
CompletableFuture<SimulateTemplateResponse>	simulateTemplate()	Simulate an index template.
CompletableFuture<SimulateTemplateResponse>	simulateTemplate(SimulateTemplateRequest request)	Simulate an index template.
final CompletableFuture<SimulateTemplateResponse>	simulateTemplate(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)	Simulate an index template.
CompletableFuture<SplitResponse>	split(SplitRequest request)	Splits an existing index into a new index with more primary shards.
final CompletableFuture<SplitResponse>	split(Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)	Splits an existing index into a new index with more primary shards.
CompletableFuture<IndicesStatsResponse>	stats()	Returns statistics for one or more indices.
CompletableFuture<IndicesStatsResponse>	stats(IndicesStatsRequest request)	Returns statistics for one or more indices.
final CompletableFuture<IndicesStatsResponse>	stats(Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)	Returns statistics for one or more indices.
CompletableFuture<UnfreezeResponse>	unfreeze(UnfreezeRequest request)	Unfreezes an index.
final CompletableFuture<UnfreezeResponse>	unfreeze(Function<UnfreezeRequest.Builder,ObjectBuilder<UnfreezeRequest>> fn)	Unfreezes an index.
CompletableFuture<UpdateAliasesResponse>	updateAliases()	Create or update an alias.
CompletableFuture<UpdateAliasesResponse>	updateAliases(UpdateAliasesRequest request)	Create or update an alias.
final CompletableFuture<UpdateAliasesResponse>	updateAliases(Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)	Create or update an alias.
CompletableFuture<ValidateQueryResponse>	validateQuery()	Validate a query.
CompletableFuture<ValidateQueryResponse>	validateQuery(ValidateQueryRequest request)	Validate a query.
final CompletableFuture<ValidateQueryResponse>	validateQuery(Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)	Validate a query.
ElasticsearchIndicesAsyncClient	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

ElasticsearchIndicesAsyncClient

public ElasticsearchIndicesAsyncClient(ElasticsearchTransport transport)

ElasticsearchIndicesAsyncClient

public ElasticsearchIndicesAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchIndicesAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchIndicesAsyncClient>

addBlock

public CompletableFuture<AddBlockResponse> addBlock(AddBlockRequest request)

Add an index block. Limits the operations allowed on an index by blocking specific operation types.

See Also:

• Documentation on elastic.co

addBlock

public final CompletableFuture<AddBlockResponse> addBlock(Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)

Add an index block. Limits the operations allowed on an index by blocking specific operation types.

Parameters:

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

See Also:

• Documentation on elastic.co

analyze

public CompletableFuture<AnalyzeResponse> analyze(AnalyzeRequest request)

Get tokens from text analysis. The analyze API performs analysis on a text string and returns the resulting tokens.

See Also:

• Documentation on elastic.co

analyze

public final CompletableFuture<AnalyzeResponse> analyze(Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)

Get tokens from text analysis. The analyze API performs analysis on a text string and returns the resulting tokens.

Parameters:

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

See Also:

• Documentation on elastic.co

analyze

public CompletableFuture<AnalyzeResponse> analyze()

Get tokens from text analysis. The analyze API performs analysis on a text string and returns the resulting tokens.

See Also:

• Documentation on elastic.co

clearCache

public CompletableFuture<ClearCacheResponse> clearCache(ClearCacheRequest request)

Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices.

See Also:

• Documentation on elastic.co

clearCache

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

Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

clearCache

public CompletableFuture<ClearCacheResponse> clearCache()

Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices.

See Also:

• Documentation on elastic.co

clone

public CompletableFuture<CloneIndexResponse> clone(CloneIndexRequest request)

Clones an existing index.

See Also:

• Documentation on elastic.co

clone

public final CompletableFuture<CloneIndexResponse> clone(Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)

Clones an existing index.

Parameters:

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

See Also:

• Documentation on elastic.co

close

public CompletableFuture<CloseIndexResponse> close(CloseIndexRequest request)

Closes an index.

See Also:

• Documentation on elastic.co

close

public final CompletableFuture<CloseIndexResponse> close(Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)

Closes an index.

Parameters:

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

See Also:

• Documentation on elastic.co

create

public CompletableFuture<CreateIndexResponse> create(CreateIndexRequest request)

Create an index. Creates a new index.

See Also:

• Documentation on elastic.co

create

public final CompletableFuture<CreateIndexResponse> create(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)

Create an index. Creates a new index.

Parameters:

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

See Also:

• Documentation on elastic.co

createDataStream

public CompletableFuture<CreateDataStreamResponse> createDataStream(CreateDataStreamRequest request)

Create a data stream. Creates a data stream. You must have a matching index template with data stream enabled.

See Also:

• Documentation on elastic.co

createDataStream

public final CompletableFuture<CreateDataStreamResponse> createDataStream(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)

Create a data stream. Creates a data stream. You must have a matching index template with data stream enabled.

Parameters:

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

See Also:

• Documentation on elastic.co

dataStreamsStats

public CompletableFuture<DataStreamsStatsResponse> dataStreamsStats(DataStreamsStatsRequest request)

Get data stream stats. Retrieves statistics for one or more data streams.

See Also:

• Documentation on elastic.co

dataStreamsStats

public final CompletableFuture<DataStreamsStatsResponse> dataStreamsStats(Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)

Get data stream stats. Retrieves statistics for one or more data streams.

Parameters:

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

See Also:

• Documentation on elastic.co

dataStreamsStats

public CompletableFuture<DataStreamsStatsResponse> dataStreamsStats()

Get data stream stats. Retrieves statistics for one or more data streams.

See Also:

• Documentation on elastic.co

delete

public CompletableFuture<DeleteIndexResponse> delete(DeleteIndexRequest request)

Delete indices. Deletes one or more indices.

See Also:

• Documentation on elastic.co

delete

public final CompletableFuture<DeleteIndexResponse> delete(Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)

Delete indices. Deletes one or more indices.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteAlias

public CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest request)

Delete an alias. Removes a data stream or index from an alias.

See Also:

• Documentation on elastic.co

deleteAlias

public final CompletableFuture<DeleteAliasResponse> deleteAlias(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)

Delete an alias. Removes a data stream or index from an alias.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteDataLifecycle

public CompletableFuture<DeleteDataLifecycleResponse> deleteDataLifecycle(DeleteDataLifecycleRequest request)

Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

See Also:

• Documentation on elastic.co

deleteDataLifecycle

public final CompletableFuture<DeleteDataLifecycleResponse> deleteDataLifecycle(Function<DeleteDataLifecycleRequest.Builder,ObjectBuilder<DeleteDataLifecycleRequest>> fn)

Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteDataStream

public CompletableFuture<DeleteDataStreamResponse> deleteDataStream(DeleteDataStreamRequest request)

Delete data streams. Deletes one or more data streams and their backing indices.

See Also:

• Documentation on elastic.co

deleteDataStream

public final CompletableFuture<DeleteDataStreamResponse> deleteDataStream(Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)

Delete data streams. Deletes one or more data streams and their backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteIndexTemplate

public CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate(DeleteIndexTemplateRequest request)

Delete an index template. The provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

See Also:

• Documentation on elastic.co

deleteIndexTemplate

public final CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)

Delete an index template. The provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteTemplate

public CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest request)

Deletes a legacy index template.

See Also:

• Documentation on elastic.co

deleteTemplate

public final CompletableFuture<DeleteTemplateResponse> deleteTemplate(Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)

Deletes a legacy index template.

Parameters:

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

See Also:

• Documentation on elastic.co

diskUsage

public CompletableFuture<DiskUsageResponse> diskUsage(DiskUsageRequest request)

Analyzes the disk usage of each field of an index or data stream.

See Also:

• Documentation on elastic.co

diskUsage

public final CompletableFuture<DiskUsageResponse> diskUsage(Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> fn)

Analyzes the disk usage of each field of an index or data stream.

Parameters:

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

See Also:

• Documentation on elastic.co

downsample

public CompletableFuture<DownsampleResponse> downsample(DownsampleRequest request)

Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.

See Also:

• Documentation on elastic.co

downsample

public final CompletableFuture<DownsampleResponse> downsample(Function<DownsampleRequest.Builder,ObjectBuilder<DownsampleRequest>> fn)

Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.

Parameters:

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

See Also:

• Documentation on elastic.co

exists

public CompletableFuture<BooleanResponse> exists(ExistsRequest request)

Check indices. Checks if one or more indices, index aliases, or data streams exist.

See Also:

• Documentation on elastic.co

exists

public final CompletableFuture<BooleanResponse> exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)

Check indices. Checks if one or more indices, index aliases, or data streams exist.

Parameters:

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

See Also:

• Documentation on elastic.co

existsAlias

public CompletableFuture<BooleanResponse> existsAlias(ExistsAliasRequest request)

Check aliases. Checks if one or more data stream or index aliases exist.

See Also:

• Documentation on elastic.co

existsAlias

public final CompletableFuture<BooleanResponse> existsAlias(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)

Check aliases. Checks if one or more data stream or index aliases exist.

Parameters:

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

See Also:

• Documentation on elastic.co

existsIndexTemplate

public CompletableFuture<BooleanResponse> existsIndexTemplate(ExistsIndexTemplateRequest request)

Returns information about whether a particular index template exists.

See Also:

• Documentation on elastic.co

existsIndexTemplate

public final CompletableFuture<BooleanResponse> existsIndexTemplate(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)

Returns information about whether a particular index template exists.

Parameters:

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

See Also:

• Documentation on elastic.co

existsTemplate

public CompletableFuture<BooleanResponse> existsTemplate(ExistsTemplateRequest request)

Check existence of index templates. Returns information about whether a particular index template exists.

See Also:

• Documentation on elastic.co

existsTemplate

public final CompletableFuture<BooleanResponse> existsTemplate(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)

Check existence of index templates. Returns information about whether a particular index template exists.

Parameters:

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

See Also:

• Documentation on elastic.co

explainDataLifecycle

public CompletableFuture<ExplainDataLifecycleResponse> explainDataLifecycle(ExplainDataLifecycleRequest request)

Get the status for a data stream lifecycle. Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

See Also:

• Documentation on elastic.co

explainDataLifecycle

public final CompletableFuture<ExplainDataLifecycleResponse> explainDataLifecycle(Function<ExplainDataLifecycleRequest.Builder,ObjectBuilder<ExplainDataLifecycleRequest>> fn)

Get the status for a data stream lifecycle. Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

Parameters:

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

See Also:

• Documentation on elastic.co

fieldUsageStats

public CompletableFuture<FieldUsageStatsResponse> fieldUsageStats(FieldUsageStatsRequest request)

Returns field usage information for each shard and field of an index.

See Also:

• Documentation on elastic.co

fieldUsageStats

public final CompletableFuture<FieldUsageStatsResponse> fieldUsageStats(Function<FieldUsageStatsRequest.Builder,ObjectBuilder<FieldUsageStatsRequest>> fn)

Returns field usage information for each shard and field of an index.

Parameters:

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

See Also:

• Documentation on elastic.co

flush

public CompletableFuture<FlushResponse> flush(FlushRequest request)

Flushes one or more data streams or indices.

See Also:

• Documentation on elastic.co

flush

public final CompletableFuture<FlushResponse> flush(Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)

Flushes one or more data streams or indices.

Parameters:

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

See Also:

• Documentation on elastic.co

flush

public CompletableFuture<FlushResponse> flush()

Flushes one or more data streams or indices.

See Also:

• Documentation on elastic.co

forcemerge

public CompletableFuture<ForcemergeResponse> forcemerge(ForcemergeRequest request)

Performs the force merge operation on one or more indices.

See Also:

• Documentation on elastic.co

forcemerge

public final CompletableFuture<ForcemergeResponse> forcemerge(Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)

Performs the force merge operation on one or more indices.

Parameters:

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

See Also:

• Documentation on elastic.co

forcemerge

public CompletableFuture<ForcemergeResponse> forcemerge()

Performs the force merge operation on one or more indices.

See Also:

• Documentation on elastic.co

get

public CompletableFuture<GetIndexResponse> get(GetIndexRequest request)

Get index information. Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices.

See Also:

• Documentation on elastic.co

get

public final CompletableFuture<GetIndexResponse> get(Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)

Get index information. Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

getAlias

public CompletableFuture<GetAliasResponse> getAlias(GetAliasRequest request)

Get aliases. Retrieves information for one or more data stream or index aliases.

See Also:

• Documentation on elastic.co

getAlias

public final CompletableFuture<GetAliasResponse> getAlias(Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)

Get aliases. Retrieves information for one or more data stream or index aliases.

Parameters:

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

See Also:

• Documentation on elastic.co

getAlias

public CompletableFuture<GetAliasResponse> getAlias()

Get aliases. Retrieves information for one or more data stream or index aliases.

See Also:

• Documentation on elastic.co

getDataLifecycle

public CompletableFuture<GetDataLifecycleResponse> getDataLifecycle(GetDataLifecycleRequest request)

Get data stream lifecycles. Retrieves the data stream lifecycle configuration of one or more data streams.

See Also:

• Documentation on elastic.co

getDataLifecycle

public final CompletableFuture<GetDataLifecycleResponse> getDataLifecycle(Function<GetDataLifecycleRequest.Builder,ObjectBuilder<GetDataLifecycleRequest>> fn)

Get data stream lifecycles. Retrieves the data stream lifecycle configuration of one or more data streams.

Parameters:

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

See Also:

• Documentation on elastic.co

getDataStream

public CompletableFuture<GetDataStreamResponse> getDataStream(GetDataStreamRequest request)

Get data streams. Retrieves information about one or more data streams.

See Also:

• Documentation on elastic.co

getDataStream

public final CompletableFuture<GetDataStreamResponse> getDataStream(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)

Get data streams. Retrieves information about one or more data streams.

Parameters:

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

See Also:

• Documentation on elastic.co

getDataStream

public CompletableFuture<GetDataStreamResponse> getDataStream()

Get data streams. Retrieves information about one or more data streams.

See Also:

• Documentation on elastic.co

getFieldMapping

public CompletableFuture<GetFieldMappingResponse> getFieldMapping(GetFieldMappingRequest request)

Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

See Also:

• Documentation on elastic.co

getFieldMapping

public final CompletableFuture<GetFieldMappingResponse> getFieldMapping(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)

Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

getIndexTemplate

public CompletableFuture<GetIndexTemplateResponse> getIndexTemplate(GetIndexTemplateRequest request)

Get index templates. Returns information about one or more index templates.

See Also:

• Documentation on elastic.co

getIndexTemplate

public final CompletableFuture<GetIndexTemplateResponse> getIndexTemplate(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)

Get index templates. Returns information about one or more index templates.

Parameters:

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

See Also:

• Documentation on elastic.co

getIndexTemplate

public CompletableFuture<GetIndexTemplateResponse> getIndexTemplate()

Get index templates. Returns information about one or more index templates.

See Also:

• Documentation on elastic.co

getMapping

public CompletableFuture<GetMappingResponse> getMapping(GetMappingRequest request)

Get mapping definitions. Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.

See Also:

• Documentation on elastic.co

getMapping

public final CompletableFuture<GetMappingResponse> getMapping(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)

Get mapping definitions. Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

getMapping

public CompletableFuture<GetMappingResponse> getMapping()

Get mapping definitions. Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.

See Also:

• Documentation on elastic.co

getSettings

public CompletableFuture<GetIndicesSettingsResponse> getSettings(GetIndicesSettingsRequest request)

Get index settings. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.

See Also:

• Documentation on elastic.co

getSettings

public final CompletableFuture<GetIndicesSettingsResponse> getSettings(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)

Get index settings. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

getSettings

public CompletableFuture<GetIndicesSettingsResponse> getSettings()

Get index settings. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.

See Also:

• Documentation on elastic.co

getTemplate

public CompletableFuture<GetTemplateResponse> getTemplate(GetTemplateRequest request)

Get index templates. Retrieves information about one or more index templates.

See Also:

• Documentation on elastic.co

getTemplate

public final CompletableFuture<GetTemplateResponse> getTemplate(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)

Get index templates. Retrieves information about one or more index templates.

Parameters:

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

See Also:

• Documentation on elastic.co

getTemplate

public CompletableFuture<GetTemplateResponse> getTemplate()

Get index templates. Retrieves information about one or more index templates.

See Also:

• Documentation on elastic.co

migrateToDataStream

public CompletableFuture<MigrateToDataStreamResponse> migrateToDataStream(MigrateToDataStreamRequest request)

Convert an index alias to a data stream. Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

See Also:

• Documentation on elastic.co

migrateToDataStream

public final CompletableFuture<MigrateToDataStreamResponse> migrateToDataStream(Function<MigrateToDataStreamRequest.Builder,ObjectBuilder<MigrateToDataStreamRequest>> fn)

Convert an index alias to a data stream. Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

Parameters:

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

See Also:

• Documentation on elastic.co

modifyDataStream

public CompletableFuture<ModifyDataStreamResponse> modifyDataStream(ModifyDataStreamRequest request)

Update data streams. Performs one or more data stream modification actions in a single atomic operation.

See Also:

• Documentation on elastic.co

modifyDataStream

public final CompletableFuture<ModifyDataStreamResponse> modifyDataStream(Function<ModifyDataStreamRequest.Builder,ObjectBuilder<ModifyDataStreamRequest>> fn)

Update data streams. Performs one or more data stream modification actions in a single atomic operation.

Parameters:

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

See Also:

• Documentation on elastic.co

open

public CompletableFuture<OpenResponse> open(OpenRequest request)

Opens a closed index. For data streams, the API opens any closed backing indices.

See Also:

• Documentation on elastic.co

open

public final CompletableFuture<OpenResponse> open(Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)

Opens a closed index. For data streams, the API opens any closed backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

promoteDataStream

public CompletableFuture<PromoteDataStreamResponse> promoteDataStream(PromoteDataStreamRequest request)

Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

See Also:

• Documentation on elastic.co

promoteDataStream

public final CompletableFuture<PromoteDataStreamResponse> promoteDataStream(Function<PromoteDataStreamRequest.Builder,ObjectBuilder<PromoteDataStreamRequest>> fn)

Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

Parameters:

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

See Also:

• Documentation on elastic.co

putAlias

public CompletableFuture<PutAliasResponse> putAlias(PutAliasRequest request)

Create or update an alias. Adds a data stream or index to an alias.

See Also:

• Documentation on elastic.co

putAlias

public final CompletableFuture<PutAliasResponse> putAlias(Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)

Create or update an alias. Adds a data stream or index to an alias.

Parameters:

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

See Also:

• Documentation on elastic.co

putDataLifecycle

public CompletableFuture<PutDataLifecycleResponse> putDataLifecycle(PutDataLifecycleRequest request)

Update data stream lifecycles. Update the data stream lifecycle of the specified data streams.

See Also:

• Documentation on elastic.co

putDataLifecycle

public final CompletableFuture<PutDataLifecycleResponse> putDataLifecycle(Function<PutDataLifecycleRequest.Builder,ObjectBuilder<PutDataLifecycleRequest>> fn)

Update data stream lifecycles. Update the data stream lifecycle of the specified data streams.

Parameters:

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

See Also:

• Documentation on elastic.co

putIndexTemplate

public CompletableFuture<PutIndexTemplateResponse> putIndexTemplate(PutIndexTemplateRequest request)

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

See Also:

• Documentation on elastic.co

putIndexTemplate

public final CompletableFuture<PutIndexTemplateResponse> putIndexTemplate(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Parameters:

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

See Also:

• Documentation on elastic.co

putMapping

public CompletableFuture<PutMappingResponse> putMapping(PutMappingRequest request)

Update field mappings. Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.

See Also:

• Documentation on elastic.co

putMapping

public final CompletableFuture<PutMappingResponse> putMapping(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)

Update field mappings. Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.

Parameters:

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

See Also:

• Documentation on elastic.co

putSettings

public CompletableFuture<PutIndicesSettingsResponse> putSettings(PutIndicesSettingsRequest request)

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

See Also:

• Documentation on elastic.co

putSettings

public final CompletableFuture<PutIndicesSettingsResponse> putSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

Parameters:

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

See Also:

• Documentation on elastic.co

putSettings

public CompletableFuture<PutIndicesSettingsResponse> putSettings()

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

See Also:

• Documentation on elastic.co

putTemplate

public CompletableFuture<PutTemplateResponse> putTemplate(PutTemplateRequest request)

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

See Also:

• Documentation on elastic.co

putTemplate

public final CompletableFuture<PutTemplateResponse> putTemplate(Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Parameters:

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

See Also:

• Documentation on elastic.co

recovery

public CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request)

Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices.

See Also:

• Documentation on elastic.co

recovery

public final CompletableFuture<RecoveryResponse> recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)

Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

recovery

public CompletableFuture<RecoveryResponse> recovery()

Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices.

See Also:

• Documentation on elastic.co

refresh

public CompletableFuture<RefreshResponse> refresh(RefreshRequest request)

Refresh an index. A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

See Also:

• Documentation on elastic.co

refresh

public final CompletableFuture<RefreshResponse> refresh(Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)

Refresh an index. A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

refresh

public CompletableFuture<RefreshResponse> refresh()

Refresh an index. A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

See Also:

• Documentation on elastic.co

reloadSearchAnalyzers

public CompletableFuture<ReloadSearchAnalyzersResponse> reloadSearchAnalyzers(ReloadSearchAnalyzersRequest request)

Reloads an index's search analyzers and their resources.

See Also:

• Documentation on elastic.co

reloadSearchAnalyzers

public final CompletableFuture<ReloadSearchAnalyzersResponse> reloadSearchAnalyzers(Function<ReloadSearchAnalyzersRequest.Builder,ObjectBuilder<ReloadSearchAnalyzersRequest>> fn)

Reloads an index's search analyzers and their resources.

Parameters:

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

See Also:

• Documentation on elastic.co

resolveCluster

public CompletableFuture<ResolveClusterResponse> resolveCluster(ResolveClusterRequest request)

Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.

See Also:

• Documentation on elastic.co

resolveCluster

public final CompletableFuture<ResolveClusterResponse> resolveCluster(Function<ResolveClusterRequest.Builder,ObjectBuilder<ResolveClusterRequest>> fn)

Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.

Parameters:

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

See Also:

• Documentation on elastic.co

resolveIndex

public CompletableFuture<ResolveIndexResponse> resolveIndex(ResolveIndexRequest request)

Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

See Also:

• Documentation on elastic.co

resolveIndex

public final CompletableFuture<ResolveIndexResponse> resolveIndex(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)

Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

Parameters:

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

See Also:

• Documentation on elastic.co

rollover

public CompletableFuture<RolloverResponse> rollover(RolloverRequest request)

Roll over to a new index. Creates a new index for a data stream or index alias.

See Also:

• Documentation on elastic.co

rollover

public final CompletableFuture<RolloverResponse> rollover(Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)

Roll over to a new index. Creates a new index for a data stream or index alias.

Parameters:

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

See Also:

• Documentation on elastic.co

segments

public CompletableFuture<SegmentsResponse> segments(SegmentsRequest request)

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

See Also:

• Documentation on elastic.co

segments

public final CompletableFuture<SegmentsResponse> segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

segments

public CompletableFuture<SegmentsResponse> segments()

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

See Also:

• Documentation on elastic.co

shardStores

public CompletableFuture<ShardStoresResponse> shardStores(ShardStoresRequest request)

Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices.

See Also:

• Documentation on elastic.co

shardStores

public final CompletableFuture<ShardStoresResponse> shardStores(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)

Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

shardStores

public CompletableFuture<ShardStoresResponse> shardStores()

Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices.

See Also:

• Documentation on elastic.co

shrink

public CompletableFuture<ShrinkResponse> shrink(ShrinkRequest request)

Shrinks an existing index into a new index with fewer primary shards.

See Also:

• Documentation on elastic.co

shrink

public final CompletableFuture<ShrinkResponse> shrink(Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)

Shrinks an existing index into a new index with fewer primary shards.

Parameters:

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

See Also:

• Documentation on elastic.co

simulateIndexTemplate

public CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate(SimulateIndexTemplateRequest request)

Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template.

See Also:

• Documentation on elastic.co

simulateIndexTemplate

public final CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)

Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template.

Parameters:

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

See Also:

• Documentation on elastic.co

simulateTemplate

public CompletableFuture<SimulateTemplateResponse> simulateTemplate(SimulateTemplateRequest request)

Simulate an index template. Returns the index configuration that would be applied by a particular index template.

See Also:

• Documentation on elastic.co

simulateTemplate

public final CompletableFuture<SimulateTemplateResponse> simulateTemplate(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)

Simulate an index template. Returns the index configuration that would be applied by a particular index template.

Parameters:

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

See Also:

• Documentation on elastic.co

simulateTemplate

public CompletableFuture<SimulateTemplateResponse> simulateTemplate()

Simulate an index template. Returns the index configuration that would be applied by a particular index template.

See Also:

• Documentation on elastic.co

split

public CompletableFuture<SplitResponse> split(SplitRequest request)

Splits an existing index into a new index with more primary shards.

See Also:

• Documentation on elastic.co

split

public final CompletableFuture<SplitResponse> split(Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)

Splits an existing index into a new index with more primary shards.

Parameters:

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<IndicesStatsResponse> stats(IndicesStatsRequest request)

Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices.

See Also:

• Documentation on elastic.co

stats

public final CompletableFuture<IndicesStatsResponse> stats(Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)

Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices.

Parameters:

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<IndicesStatsResponse> stats()

Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices.

See Also:

• Documentation on elastic.co

unfreeze

public CompletableFuture<UnfreezeResponse> unfreeze(UnfreezeRequest request)

Unfreezes an index.

See Also:

• Documentation on elastic.co

unfreeze

public final CompletableFuture<UnfreezeResponse> unfreeze(Function<UnfreezeRequest.Builder,ObjectBuilder<UnfreezeRequest>> fn)

Unfreezes an index.

Parameters:

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

See Also:

• Documentation on elastic.co

updateAliases

public CompletableFuture<UpdateAliasesResponse> updateAliases(UpdateAliasesRequest request)

Create or update an alias. Adds a data stream or index to an alias.

See Also:

• Documentation on elastic.co

updateAliases

public final CompletableFuture<UpdateAliasesResponse> updateAliases(Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)

Create or update an alias. Adds a data stream or index to an alias.

Parameters:

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

See Also:

• Documentation on elastic.co

updateAliases

public CompletableFuture<UpdateAliasesResponse> updateAliases()

Create or update an alias. Adds a data stream or index to an alias.

See Also:

• Documentation on elastic.co

validateQuery

public CompletableFuture<ValidateQueryResponse> validateQuery(ValidateQueryRequest request)

Validate a query. Validates a query without running it.

See Also:

• Documentation on elastic.co

validateQuery

public final CompletableFuture<ValidateQueryResponse> validateQuery(Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)

Validate a query. Validates a query without running it.

Parameters:

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

See Also:

• Documentation on elastic.co

validateQuery

public CompletableFuture<ValidateQueryResponse> validateQuery()

Validate a query. Validates a query without running it.

See Also:

• Documentation on elastic.co