Package org.opensearch.client.opensearch.indices

Class OpenSearchIndicesAsyncClientBase<Self extends OpenSearchIndicesAsyncClientBase<Self>>

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,Self>

org.opensearch.client.opensearch.indices.OpenSearchIndicesAsyncClientBase<Self>

Direct Known Subclasses:

OpenSearchIndicesAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class OpenSearchIndicesAsyncClientBase<Self extends OpenSearchIndicesAsyncClientBase<Self>>
extends ApiClient<OpenSearchTransport,Self>

Client for the indices namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchIndicesAsyncClientBase(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<AddBlockResponse>	addBlock(Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)	Adds a block to an index.
CompletableFuture<AddBlockResponse>	addBlock(AddBlockRequest request)	Adds a block to an index.
final CompletableFuture<AnalyzeResponse>	analyze()	Performs the analysis process on a text and return the tokens breakdown of the text.
final CompletableFuture<AnalyzeResponse>	analyze(Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)	Performs the analysis process on a text and return the tokens breakdown of the text.
CompletableFuture<AnalyzeResponse>	analyze(AnalyzeRequest request)	Performs the analysis process on a text and return the tokens breakdown of the text.
final CompletableFuture<ClearCacheResponse>	clearCache()	Clears all or specific caches for one or more indexes.
final CompletableFuture<ClearCacheResponse>	clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clears all or specific caches for one or more indexes.
CompletableFuture<ClearCacheResponse>	clearCache(ClearCacheRequest request)	Clears all or specific caches for one or more indexes.
final CompletableFuture<CloneIndexResponse>	clone(Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)	Clones an index.
CompletableFuture<CloneIndexResponse>	clone(CloneIndexRequest request)	Clones an index.
final CompletableFuture<CloseIndexResponse>	close(Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)	Closes an index.
CompletableFuture<CloseIndexResponse>	close(CloseIndexRequest request)	Closes an index.
final CompletableFuture<CreateIndexResponse>	create(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)	Creates an index with optional settings and mappings.
CompletableFuture<CreateIndexResponse>	create(CreateIndexRequest request)	Creates an index with optional settings and mappings.
final CompletableFuture<CreateDataStreamResponse>	createDataStream(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)	Creates or updates a data stream.
CompletableFuture<CreateDataStreamResponse>	createDataStream(CreateDataStreamRequest request)	Creates or updates a data stream.
final CompletableFuture<DataStreamsStatsResponse>	dataStreamsStats()	Provides statistics on operations happening in a data stream.
final CompletableFuture<DataStreamsStatsResponse>	dataStreamsStats(Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)	Provides statistics on operations happening in a data stream.
CompletableFuture<DataStreamsStatsResponse>	dataStreamsStats(DataStreamsStatsRequest request)	Provides statistics on operations happening in a data stream.
final CompletableFuture<DeleteIndexResponse>	delete(Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)	Deletes an index.
CompletableFuture<DeleteIndexResponse>	delete(DeleteIndexRequest request)	Deletes an index.
final CompletableFuture<DeleteAliasResponse>	deleteAlias(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)	Deletes an alias.
CompletableFuture<DeleteAliasResponse>	deleteAlias(DeleteAliasRequest request)	Deletes an alias.
final CompletableFuture<DeleteDataStreamResponse>	deleteDataStream(Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)	Deletes a data stream.
CompletableFuture<DeleteDataStreamResponse>	deleteDataStream(DeleteDataStreamRequest request)	Deletes a data stream.
final CompletableFuture<DeleteIndexTemplateResponse>	deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)	Deletes an index template.
CompletableFuture<DeleteIndexTemplateResponse>	deleteIndexTemplate(DeleteIndexTemplateRequest request)	Deletes an index template.
final CompletableFuture<DeleteTemplateResponse>	deleteTemplate(Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)	Deletes an index template.
CompletableFuture<DeleteTemplateResponse>	deleteTemplate(DeleteTemplateRequest request)	Deletes an index template.
final CompletableFuture<BooleanResponse>	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Returns information about whether a particular index exists.
CompletableFuture<BooleanResponse>	exists(ExistsRequest request)	Returns information about whether a particular index exists.
final CompletableFuture<BooleanResponse>	existsAlias(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)	Returns information about whether a particular alias exists.
CompletableFuture<BooleanResponse>	existsAlias(ExistsAliasRequest request)	Returns information about whether a particular alias exists.
final CompletableFuture<BooleanResponse>	existsIndexTemplate(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)	Returns information about whether a particular index template exists.
CompletableFuture<BooleanResponse>	existsIndexTemplate(ExistsIndexTemplateRequest request)	Returns information about whether a particular index template exists.
final CompletableFuture<BooleanResponse>	existsTemplate(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)	Returns information about whether a particular index template exists.
CompletableFuture<BooleanResponse>	existsTemplate(ExistsTemplateRequest request)	Returns information about whether a particular index template exists.
final CompletableFuture<FlushResponse>	flush()	Performs the flush operation on one or more indexes.
final CompletableFuture<FlushResponse>	flush(Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)	Performs the flush operation on one or more indexes.
CompletableFuture<FlushResponse>	flush(FlushRequest request)	Performs the flush operation on one or more indexes.
final CompletableFuture<ForcemergeResponse>	forcemerge()	Performs the force merge operation on one or more indexes.
final CompletableFuture<ForcemergeResponse>	forcemerge(Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)	Performs the force merge operation on one or more indexes.
CompletableFuture<ForcemergeResponse>	forcemerge(ForcemergeRequest request)	Performs the force merge operation on one or more indexes.
final CompletableFuture<GetIndexResponse>	get(Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)	Returns information about one or more indexes.
CompletableFuture<GetIndexResponse>	get(GetIndexRequest request)	Returns information about one or more indexes.
final CompletableFuture<GetAliasResponse>	getAlias()	Returns an alias.
final CompletableFuture<GetAliasResponse>	getAlias(Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)	Returns an alias.
CompletableFuture<GetAliasResponse>	getAlias(GetAliasRequest request)	Returns an alias.
final CompletableFuture<GetDataStreamResponse>	getDataStream()	Returns data streams.
final CompletableFuture<GetDataStreamResponse>	getDataStream(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)	Returns data streams.
CompletableFuture<GetDataStreamResponse>	getDataStream(GetDataStreamRequest request)	Returns data streams.
final CompletableFuture<GetIndexTemplateResponse>	getIndexTemplate()	Returns an index template.
final CompletableFuture<GetIndexTemplateResponse>	getIndexTemplate(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)	Returns an index template.
CompletableFuture<GetIndexTemplateResponse>	getIndexTemplate(GetIndexTemplateRequest request)	Returns an index template.
final CompletableFuture<GetMappingResponse>	getMapping()	Returns mappings for one or more indexes.
final CompletableFuture<GetMappingResponse>	getMapping(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)	Returns mappings for one or more indexes.
CompletableFuture<GetMappingResponse>	getMapping(GetMappingRequest request)	Returns mappings for one or more indexes.
final CompletableFuture<GetIndicesSettingsResponse>	getSettings()	Returns settings for one or more indexes.
final CompletableFuture<GetIndicesSettingsResponse>	getSettings(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)	Returns settings for one or more indexes.
CompletableFuture<GetIndicesSettingsResponse>	getSettings(GetIndicesSettingsRequest request)	Returns settings for one or more indexes.
final CompletableFuture<GetTemplateResponse>	getTemplate()	Returns an index template.
final CompletableFuture<GetTemplateResponse>	getTemplate(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)	Returns an index template.
CompletableFuture<GetTemplateResponse>	getTemplate(GetTemplateRequest request)	Returns an index template.
final CompletableFuture<OpenResponse>	open(Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)	Opens an index.
CompletableFuture<OpenResponse>	open(OpenRequest request)	Opens an index.
final CompletableFuture<PutAliasResponse>	putAlias()	Creates or updates an alias.
final CompletableFuture<PutAliasResponse>	putAlias(Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)	Creates or updates an alias.
CompletableFuture<PutAliasResponse>	putAlias(PutAliasRequest request)	Creates or updates an alias.
final CompletableFuture<PutIndexTemplateResponse>	putIndexTemplate(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)	Creates or updates an index template.
CompletableFuture<PutIndexTemplateResponse>	putIndexTemplate(PutIndexTemplateRequest request)	Creates or updates an index template.
final CompletableFuture<PutMappingResponse>	putMapping(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)	Updates the index mappings.
CompletableFuture<PutMappingResponse>	putMapping(PutMappingRequest request)	Updates the index mappings.
final CompletableFuture<PutIndicesSettingsResponse>	putSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)	Updates the index settings.
CompletableFuture<PutIndicesSettingsResponse>	putSettings(PutIndicesSettingsRequest request)	Updates the index settings.
final CompletableFuture<PutTemplateResponse>	putTemplate(Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)	Creates or updates an index template.
CompletableFuture<PutTemplateResponse>	putTemplate(PutTemplateRequest request)	Creates or updates an index template.
final CompletableFuture<RecoveryResponse>	recovery()	Returns information about ongoing index shard recoveries.
final CompletableFuture<RecoveryResponse>	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about ongoing index shard recoveries.
CompletableFuture<RecoveryResponse>	recovery(RecoveryRequest request)	Returns information about ongoing index shard recoveries.
final CompletableFuture<RefreshResponse>	refresh()	Performs the refresh operation in one or more indexes.
final CompletableFuture<RefreshResponse>	refresh(Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)	Performs the refresh operation in one or more indexes.
CompletableFuture<RefreshResponse>	refresh(RefreshRequest request)	Performs the refresh operation in one or more indexes.
final CompletableFuture<ResolveIndexResponse>	resolveIndex(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)	Returns information about any matching indexes, aliases, and data streams.
CompletableFuture<ResolveIndexResponse>	resolveIndex(ResolveIndexRequest request)	Returns information about any matching indexes, aliases, and data streams.
final CompletableFuture<RolloverResponse>	rollover(Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)	Updates an alias to point to a new index when the existing index is considered to be too large or too old.
CompletableFuture<RolloverResponse>	rollover(RolloverRequest request)	Updates an alias to point to a new index when the existing index is considered to be too large or too old.
final CompletableFuture<SegmentsResponse>	segments()	Provides low-level information about segments in a Lucene index.
final CompletableFuture<SegmentsResponse>	segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Provides low-level information about segments in a Lucene index.
CompletableFuture<SegmentsResponse>	segments(SegmentsRequest request)	Provides low-level information about segments in a Lucene index.
final CompletableFuture<ShardStoresResponse>	shardStores()	Provides store information for shard copies of indexes.
final CompletableFuture<ShardStoresResponse>	shardStores(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)	Provides store information for shard copies of indexes.
CompletableFuture<ShardStoresResponse>	shardStores(ShardStoresRequest request)	Provides store information for shard copies of indexes.
final CompletableFuture<ShrinkResponse>	shrink(Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)	Allow to shrink an existing index into a new index with fewer primary shards.
CompletableFuture<ShrinkResponse>	shrink(ShrinkRequest request)	Allow to shrink an existing index into a new index with fewer primary shards.
final CompletableFuture<SimulateIndexTemplateResponse>	simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)	Simulate matching the given index name against the index templates in the system.
CompletableFuture<SimulateIndexTemplateResponse>	simulateIndexTemplate(SimulateIndexTemplateRequest request)	Simulate matching the given index name against the index templates in the system.
final CompletableFuture<SimulateTemplateResponse>	simulateTemplate(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)	Simulate resolving the given template name or body.
CompletableFuture<SimulateTemplateResponse>	simulateTemplate(SimulateTemplateRequest request)	Simulate resolving the given template name or body.
final CompletableFuture<SplitResponse>	split(Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)	Allows you to split an existing index into a new index with more primary shards.
CompletableFuture<SplitResponse>	split(SplitRequest request)	Allows you to split an existing index into a new index with more primary shards.
final CompletableFuture<IndicesStatsResponse>	stats()	Provides statistics on operations happening in an index.
final CompletableFuture<IndicesStatsResponse>	stats(Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)	Provides statistics on operations happening in an index.
CompletableFuture<IndicesStatsResponse>	stats(IndicesStatsRequest request)	Provides statistics on operations happening in an index.
final CompletableFuture<UpdateAliasesResponse>	updateAliases()	Updates index aliases.
final CompletableFuture<UpdateAliasesResponse>	updateAliases(Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)	Updates index aliases.
CompletableFuture<UpdateAliasesResponse>	updateAliases(UpdateAliasesRequest request)	Updates index aliases.
final CompletableFuture<ValidateQueryResponse>	validateQuery()	Allows a user to validate a potentially expensive query without executing it.
final CompletableFuture<ValidateQueryResponse>	validateQuery(Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)	Allows a user to validate a potentially expensive query without executing it.
CompletableFuture<ValidateQueryResponse>	validateQuery(ValidateQueryRequest request)	Allows a user to validate a potentially expensive query without executing it.

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchIndicesAsyncClientBase

public OpenSearchIndicesAsyncClientBase(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

addBlock

public CompletableFuture<AddBlockResponse> addBlock(AddBlockRequest request)
                                             throws IOException,
OpenSearchException

Adds a block to an index.

Throws:

IOException

OpenSearchException

addBlock

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

Adds a block to an index.

Parameters:

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

Throws:

IOException

OpenSearchException

analyze

public CompletableFuture<AnalyzeResponse> analyze(AnalyzeRequest request)
                                           throws IOException,
OpenSearchException

Performs the analysis process on a text and return the tokens breakdown of the text.

Throws:

IOException

OpenSearchException

analyze

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

Performs the analysis process on a text and return the tokens breakdown of the text.

Parameters:

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

Throws:

IOException

OpenSearchException

analyze

public final CompletableFuture<AnalyzeResponse> analyze()
                                                 throws IOException,
OpenSearchException

Performs the analysis process on a text and return the tokens breakdown of the text.

Throws:

IOException

OpenSearchException

clearCache

public CompletableFuture<ClearCacheResponse> clearCache(ClearCacheRequest request)
                                                 throws IOException,
OpenSearchException

Clears all or specific caches for one or more indexes.

Throws:

IOException

OpenSearchException

clearCache

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

Clears all or specific caches for one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

clearCache

public final CompletableFuture<ClearCacheResponse> clearCache()
                                                       throws IOException,
OpenSearchException

Clears all or specific caches for one or more indexes.

Throws:

IOException

OpenSearchException

clone

public CompletableFuture<CloneIndexResponse> clone(CloneIndexRequest request)
                                            throws IOException,
OpenSearchException

Clones an index.

Throws:

IOException

OpenSearchException

clone

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

Clones an index.

Parameters:

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

Throws:

IOException

OpenSearchException

close

public CompletableFuture<CloseIndexResponse> close(CloseIndexRequest request)
                                            throws IOException,
OpenSearchException

Closes an index.

Throws:

IOException

OpenSearchException

close

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

Closes an index.

Parameters:

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

Throws:

IOException

OpenSearchException

create

public CompletableFuture<CreateIndexResponse> create(CreateIndexRequest request)
                                              throws IOException,
OpenSearchException

Creates an index with optional settings and mappings.

Throws:

IOException

OpenSearchException

create

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

Creates an index with optional settings and mappings.

Parameters:

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

Throws:

IOException

OpenSearchException

createDataStream

public CompletableFuture<CreateDataStreamResponse> createDataStream(CreateDataStreamRequest request)
                                                             throws IOException,
OpenSearchException

Creates or updates a data stream.

Throws:

IOException

OpenSearchException

createDataStream

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

Creates or updates a data stream.

Parameters:

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

Throws:

IOException

OpenSearchException

dataStreamsStats

public CompletableFuture<DataStreamsStatsResponse> dataStreamsStats(DataStreamsStatsRequest request)
                                                             throws IOException,
OpenSearchException

Provides statistics on operations happening in a data stream.

Throws:

IOException

OpenSearchException

dataStreamsStats

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

Provides statistics on operations happening in a data stream.

Parameters:

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

Throws:

IOException

OpenSearchException

dataStreamsStats

public final CompletableFuture<DataStreamsStatsResponse> dataStreamsStats()
                                                                   throws IOException,
OpenSearchException

Provides statistics on operations happening in a data stream.

Throws:

IOException

OpenSearchException

delete

public CompletableFuture<DeleteIndexResponse> delete(DeleteIndexRequest request)
                                              throws IOException,
OpenSearchException

Deletes an index.

Throws:

IOException

OpenSearchException

delete

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

Deletes an index.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteAlias

public CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest request)
                                                   throws IOException,
OpenSearchException

Deletes an alias.

Throws:

IOException

OpenSearchException

deleteAlias

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

Deletes an alias.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteDataStream

public CompletableFuture<DeleteDataStreamResponse> deleteDataStream(DeleteDataStreamRequest request)
                                                             throws IOException,
OpenSearchException

Deletes a data stream.

Throws:

IOException

OpenSearchException

deleteDataStream

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

Deletes a data stream.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteIndexTemplate

public CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate(DeleteIndexTemplateRequest request)
                                                                   throws IOException,
OpenSearchException

Deletes an index template.

Throws:

IOException

OpenSearchException

deleteIndexTemplate

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

Deletes an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteTemplate

public CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest request)
                                                         throws IOException,
OpenSearchException

Deletes an index template.

Throws:

IOException

OpenSearchException

deleteTemplate

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

Deletes an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

exists

public CompletableFuture<BooleanResponse> exists(ExistsRequest request)
                                          throws IOException,
OpenSearchException

Returns information about whether a particular index exists.

Throws:

IOException

OpenSearchException

exists

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

Returns information about whether a particular index exists.

Parameters:

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

Throws:

IOException

OpenSearchException

existsAlias

public CompletableFuture<BooleanResponse> existsAlias(ExistsAliasRequest request)
                                               throws IOException,
OpenSearchException

Returns information about whether a particular alias exists.

Throws:

IOException

OpenSearchException

existsAlias

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

Returns information about whether a particular alias exists.

Parameters:

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

Throws:

IOException

OpenSearchException

existsIndexTemplate

public CompletableFuture<BooleanResponse> existsIndexTemplate(ExistsIndexTemplateRequest request)
                                                       throws IOException,
OpenSearchException

Returns information about whether a particular index template exists.

Throws:

IOException

OpenSearchException

existsIndexTemplate

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

Returns information about whether a particular index template exists.

Parameters:

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

Throws:

IOException

OpenSearchException

existsTemplate

public CompletableFuture<BooleanResponse> existsTemplate(ExistsTemplateRequest request)
                                                  throws IOException,
OpenSearchException

Returns information about whether a particular index template exists.

Throws:

IOException

OpenSearchException

existsTemplate

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

Returns information about whether a particular index template exists.

Parameters:

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

Throws:

IOException

OpenSearchException

flush

public CompletableFuture<FlushResponse> flush(FlushRequest request)
                                       throws IOException,
OpenSearchException

Performs the flush operation on one or more indexes.

Throws:

IOException

OpenSearchException

flush

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

Performs the flush operation on one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

flush

public final CompletableFuture<FlushResponse> flush()
                                             throws IOException,
OpenSearchException

Performs the flush operation on one or more indexes.

Throws:

IOException

OpenSearchException

forcemerge

public CompletableFuture<ForcemergeResponse> forcemerge(ForcemergeRequest request)
                                                 throws IOException,
OpenSearchException

Performs the force merge operation on one or more indexes.

Throws:

IOException

OpenSearchException

forcemerge

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

Performs the force merge operation on one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

forcemerge

public final CompletableFuture<ForcemergeResponse> forcemerge()
                                                       throws IOException,
OpenSearchException

Performs the force merge operation on one or more indexes.

Throws:

IOException

OpenSearchException

get

public CompletableFuture<GetIndexResponse> get(GetIndexRequest request)
                                        throws IOException,
OpenSearchException

Returns information about one or more indexes.

Throws:

IOException

OpenSearchException

get

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

Returns information about one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

getAlias

public CompletableFuture<GetAliasResponse> getAlias(GetAliasRequest request)
                                             throws IOException,
OpenSearchException

Returns an alias.

Throws:

IOException

OpenSearchException

getAlias

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

Returns an alias.

Parameters:

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

Throws:

IOException

OpenSearchException

getAlias

public final CompletableFuture<GetAliasResponse> getAlias()
                                                   throws IOException,
OpenSearchException

Returns an alias.

Throws:

IOException

OpenSearchException

getDataStream

public CompletableFuture<GetDataStreamResponse> getDataStream(GetDataStreamRequest request)
                                                       throws IOException,
OpenSearchException

Returns data streams.

Throws:

IOException

OpenSearchException

getDataStream

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

Returns data streams.

Parameters:

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

Throws:

IOException

OpenSearchException

getDataStream

public final CompletableFuture<GetDataStreamResponse> getDataStream()
                                                             throws IOException,
OpenSearchException

Returns data streams.

Throws:

IOException

OpenSearchException

getIndexTemplate

public CompletableFuture<GetIndexTemplateResponse> getIndexTemplate(GetIndexTemplateRequest request)
                                                             throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

getIndexTemplate

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

Returns an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

getIndexTemplate

public final CompletableFuture<GetIndexTemplateResponse> getIndexTemplate()
                                                                   throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

getMapping

public CompletableFuture<GetMappingResponse> getMapping(GetMappingRequest request)
                                                 throws IOException,
OpenSearchException

Returns mappings for one or more indexes.

Throws:

IOException

OpenSearchException

getMapping

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

Returns mappings for one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

getMapping

public final CompletableFuture<GetMappingResponse> getMapping()
                                                       throws IOException,
OpenSearchException

Returns mappings for one or more indexes.

Throws:

IOException

OpenSearchException

getSettings

public CompletableFuture<GetIndicesSettingsResponse> getSettings(GetIndicesSettingsRequest request)
                                                          throws IOException,
OpenSearchException

Returns settings for one or more indexes.

Throws:

IOException

OpenSearchException

getSettings

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

Returns settings for one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

getSettings

public final CompletableFuture<GetIndicesSettingsResponse> getSettings()
                                                                throws IOException,
OpenSearchException

Returns settings for one or more indexes.

Throws:

IOException

OpenSearchException

getTemplate

public CompletableFuture<GetTemplateResponse> getTemplate(GetTemplateRequest request)
                                                   throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

getTemplate

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

Returns an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

getTemplate

public final CompletableFuture<GetTemplateResponse> getTemplate()
                                                         throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

open

public CompletableFuture<OpenResponse> open(OpenRequest request)
                                     throws IOException,
OpenSearchException

Opens an index.

Throws:

IOException

OpenSearchException

open

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

Opens an index.

Parameters:

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

Throws:

IOException

OpenSearchException

putAlias

public CompletableFuture<PutAliasResponse> putAlias(PutAliasRequest request)
                                             throws IOException,
OpenSearchException

Creates or updates an alias.

Throws:

IOException

OpenSearchException

putAlias

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

Creates or updates an alias.

Parameters:

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

Throws:

IOException

OpenSearchException

putAlias

public final CompletableFuture<PutAliasResponse> putAlias()
                                                   throws IOException,
OpenSearchException

Creates or updates an alias.

Throws:

IOException

OpenSearchException

putIndexTemplate

public CompletableFuture<PutIndexTemplateResponse> putIndexTemplate(PutIndexTemplateRequest request)
                                                             throws IOException,
OpenSearchException

Creates or updates an index template.

Throws:

IOException

OpenSearchException

putIndexTemplate

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

Creates or updates an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

putMapping

public CompletableFuture<PutMappingResponse> putMapping(PutMappingRequest request)
                                                 throws IOException,
OpenSearchException

Updates the index mappings.

Throws:

IOException

OpenSearchException

putMapping

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

Updates the index mappings.

Parameters:

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

Throws:

IOException

OpenSearchException

putSettings

public CompletableFuture<PutIndicesSettingsResponse> putSettings(PutIndicesSettingsRequest request)
                                                          throws IOException,
OpenSearchException

Updates the index settings.

Throws:

IOException

OpenSearchException

putSettings

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

Updates the index settings.

Parameters:

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

Throws:

IOException

OpenSearchException

putTemplate

public CompletableFuture<PutTemplateResponse> putTemplate(PutTemplateRequest request)
                                                   throws IOException,
OpenSearchException

Creates or updates an index template.

Throws:

IOException

OpenSearchException

putTemplate

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

Creates or updates an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

recovery

public CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request)
                                             throws IOException,
OpenSearchException

Returns information about ongoing index shard recoveries.

Throws:

IOException

OpenSearchException

recovery

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

Returns information about ongoing index shard recoveries.

Parameters:

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

Throws:

IOException

OpenSearchException

recovery

public final CompletableFuture<RecoveryResponse> recovery()
                                                   throws IOException,
OpenSearchException

Returns information about ongoing index shard recoveries.

Throws:

IOException

OpenSearchException

refresh

public CompletableFuture<RefreshResponse> refresh(RefreshRequest request)
                                           throws IOException,
OpenSearchException

Performs the refresh operation in one or more indexes.

Throws:

IOException

OpenSearchException

refresh

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

Performs the refresh operation in one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

refresh

public final CompletableFuture<RefreshResponse> refresh()
                                                 throws IOException,
OpenSearchException

Performs the refresh operation in one or more indexes.

Throws:

IOException

OpenSearchException

resolveIndex

public CompletableFuture<ResolveIndexResponse> resolveIndex(ResolveIndexRequest request)
                                                     throws IOException,
OpenSearchException

Returns information about any matching indexes, aliases, and data streams.

Throws:

IOException

OpenSearchException

resolveIndex

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

Returns information about any matching indexes, aliases, and data streams.

Parameters:

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

Throws:

IOException

OpenSearchException

rollover

public CompletableFuture<RolloverResponse> rollover(RolloverRequest request)
                                             throws IOException,
OpenSearchException

Updates an alias to point to a new index when the existing index is considered to be too large or too old.

Throws:

IOException

OpenSearchException

rollover

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

Updates an alias to point to a new index when the existing index is considered to be too large or too old.

Parameters:

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

Throws:

IOException

OpenSearchException

segments

public CompletableFuture<SegmentsResponse> segments(SegmentsRequest request)
                                             throws IOException,
OpenSearchException

Provides low-level information about segments in a Lucene index.

Throws:

IOException

OpenSearchException

segments

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

Provides low-level information about segments in a Lucene index.

Parameters:

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

Throws:

IOException

OpenSearchException

segments

public final CompletableFuture<SegmentsResponse> segments()
                                                   throws IOException,
OpenSearchException

Provides low-level information about segments in a Lucene index.

Throws:

IOException

OpenSearchException

shardStores

public CompletableFuture<ShardStoresResponse> shardStores(ShardStoresRequest request)
                                                   throws IOException,
OpenSearchException

Provides store information for shard copies of indexes.

Throws:

IOException

OpenSearchException

shardStores

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

Provides store information for shard copies of indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

shardStores

public final CompletableFuture<ShardStoresResponse> shardStores()
                                                         throws IOException,
OpenSearchException

Provides store information for shard copies of indexes.

Throws:

IOException

OpenSearchException

shrink

public CompletableFuture<ShrinkResponse> shrink(ShrinkRequest request)
                                         throws IOException,
OpenSearchException

Allow to shrink an existing index into a new index with fewer primary shards.

Throws:

IOException

OpenSearchException

shrink

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

Allow to shrink an existing index into a new index with fewer primary shards.

Parameters:

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

Throws:

IOException

OpenSearchException

simulateIndexTemplate

public CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate(SimulateIndexTemplateRequest request)
                                                                       throws IOException,
OpenSearchException

Simulate matching the given index name against the index templates in the system.

Throws:

IOException

OpenSearchException

simulateIndexTemplate

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

Simulate matching the given index name against the index templates in the system.

Parameters:

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

Throws:

IOException

OpenSearchException

simulateTemplate

public CompletableFuture<SimulateTemplateResponse> simulateTemplate(SimulateTemplateRequest request)
                                                             throws IOException,
OpenSearchException

Simulate resolving the given template name or body.

Throws:

IOException

OpenSearchException

simulateTemplate

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

Simulate resolving the given template name or body.

Parameters:

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

Throws:

IOException

OpenSearchException

split

public CompletableFuture<SplitResponse> split(SplitRequest request)
                                       throws IOException,
OpenSearchException

Allows you to split an existing index into a new index with more primary shards.

Throws:

IOException

OpenSearchException

split

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

Allows you to split an existing index into a new index with more primary shards.

Parameters:

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

Throws:

IOException

OpenSearchException

stats

public CompletableFuture<IndicesStatsResponse> stats(IndicesStatsRequest request)
                                              throws IOException,
OpenSearchException

Provides statistics on operations happening in an index.

Throws:

IOException

OpenSearchException

stats

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

Provides statistics on operations happening in an index.

Parameters:

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

Throws:

IOException

OpenSearchException

stats

public final CompletableFuture<IndicesStatsResponse> stats()
                                                    throws IOException,
OpenSearchException

Provides statistics on operations happening in an index.

Throws:

IOException

OpenSearchException

updateAliases

public CompletableFuture<UpdateAliasesResponse> updateAliases(UpdateAliasesRequest request)
                                                       throws IOException,
OpenSearchException

Updates index aliases.

Throws:

IOException

OpenSearchException

updateAliases

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

Updates index aliases.

Parameters:

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

Throws:

IOException

OpenSearchException

updateAliases

public final CompletableFuture<UpdateAliasesResponse> updateAliases()
                                                             throws IOException,
OpenSearchException

Updates index aliases.

Throws:

IOException

OpenSearchException

validateQuery

public CompletableFuture<ValidateQueryResponse> validateQuery(ValidateQueryRequest request)
                                                       throws IOException,
OpenSearchException

Allows a user to validate a potentially expensive query without executing it.

Throws:

IOException

OpenSearchException

validateQuery

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

Allows a user to validate a potentially expensive query without executing it.

Parameters:

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

Throws:

IOException

OpenSearchException

validateQuery

public final CompletableFuture<ValidateQueryResponse> validateQuery()
                                                             throws IOException,
OpenSearchException

Allows a user to validate a potentially expensive query without executing it.

Throws:

IOException

OpenSearchException