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
ConstructorsConstructorDescriptionOpenSearchIndicesAsyncClientBase(OpenSearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionAdds a block to an index.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> Performs the analysis process on a text and return the tokens breakdown of the text.analyze(AnalyzeRequest request) Performs the analysis process on a text and return the tokens breakdown of the text.Clears all or specific caches for one or more indexes.Clears all or specific caches for one or more indexes.clearCache(ClearCacheRequest request) Clears all or specific caches for one or more indexes.Clones an index.clone(CloneIndexRequest request) Clones an index.Closes an index.close(CloseIndexRequest request) Closes an index.Creates an index with optional settings and mappings.create(CreateIndexRequest request) Creates an index with optional settings and mappings.createDataStream(Function<CreateDataStreamRequest.Builder, ObjectBuilder<CreateDataStreamRequest>> fn) Creates or updates a data stream.createDataStream(CreateDataStreamRequest request) Creates or updates a data stream.Provides statistics on operations happening in a data stream.dataStreamsStats(Function<DataStreamsStatsRequest.Builder, ObjectBuilder<DataStreamsStatsRequest>> fn) Provides statistics on operations happening in a data stream.dataStreamsStats(DataStreamsStatsRequest request) Provides statistics on operations happening in a data stream.Deletes an index.delete(DeleteIndexRequest request) Deletes an index.Deletes an alias.deleteAlias(DeleteAliasRequest request) Deletes an alias.deleteDataStream(Function<DeleteDataStreamRequest.Builder, ObjectBuilder<DeleteDataStreamRequest>> fn) Deletes a data stream.deleteDataStream(DeleteDataStreamRequest request) Deletes a data stream.deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder, ObjectBuilder<DeleteIndexTemplateRequest>> fn) Deletes an index template.Deletes an index template.Deletes an index template.deleteTemplate(DeleteTemplateRequest request) Deletes an index template.final CompletableFuture<BooleanResponse> Returns information about whether a particular index exists.exists(ExistsRequest request) Returns information about whether a particular index exists.final CompletableFuture<BooleanResponse> Returns information about whether a particular alias exists.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.Returns information about whether a particular index template exists.final CompletableFuture<BooleanResponse> Returns information about whether a particular index template exists.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> Performs the flush operation on one or more indexes.flush(FlushRequest request) Performs the flush operation on one or more indexes.Performs the force merge operation on one or more indexes.Performs the force merge operation on one or more indexes.forcemerge(ForcemergeRequest request) Performs the force merge operation on one or more indexes.Returns information about one or more indexes.get(GetIndexRequest request) Returns information about one or more indexes.getAlias()Returns an alias.Returns an alias.getAlias(GetAliasRequest request) Returns an alias.Returns data streams.Returns data streams.getDataStream(GetDataStreamRequest request) Returns data streams.Returns an index template.getIndexTemplate(Function<GetIndexTemplateRequest.Builder, ObjectBuilder<GetIndexTemplateRequest>> fn) Returns an index template.getIndexTemplate(GetIndexTemplateRequest request) Returns an index template.Returns mappings for one or more indexes.Returns mappings for one or more indexes.getMapping(GetMappingRequest request) Returns mappings for one or more indexes.Returns settings for one or more indexes.getSettings(Function<GetIndicesSettingsRequest.Builder, ObjectBuilder<GetIndicesSettingsRequest>> fn) Returns settings for one or more indexes.getSettings(GetIndicesSettingsRequest request) Returns settings for one or more indexes.Returns an index template.Returns an index template.getTemplate(GetTemplateRequest request) Returns an index template.final CompletableFuture<OpenResponse> Opens an index.open(OpenRequest request) Opens an index.putAlias()Creates or updates an alias.Creates or updates an alias.putAlias(PutAliasRequest request) Creates or updates an alias.putIndexTemplate(Function<PutIndexTemplateRequest.Builder, ObjectBuilder<PutIndexTemplateRequest>> fn) Creates or updates an index template.putIndexTemplate(PutIndexTemplateRequest request) Creates or updates an index template.Updates the index mappings.putMapping(PutMappingRequest request) Updates the index mappings.putSettings(Function<PutIndicesSettingsRequest.Builder, ObjectBuilder<PutIndicesSettingsRequest>> fn) Updates the index settings.putSettings(PutIndicesSettingsRequest request) Updates the index settings.Creates or updates an index template.putTemplate(PutTemplateRequest request) Creates or updates an index template.recovery()Returns information about ongoing index shard recoveries.Returns information about ongoing index shard recoveries.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> Performs the refresh operation in one or more indexes.refresh(RefreshRequest request) Performs the refresh operation in one or more indexes.Returns information about any matching indexes, aliases, and data streams.resolveIndex(ResolveIndexRequest request) Returns information about any matching indexes, aliases, and data streams.Updates an alias to point to a new index when the existing index is considered to be too large or too old.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.segments()Provides low-level information about segments in a Lucene index.Provides low-level information about segments in a Lucene index.segments(SegmentsRequest request) Provides low-level information about segments in a Lucene index.Provides store information for shard copies of indexes.Provides store information for shard copies of indexes.shardStores(ShardStoresRequest request) Provides store information for shard copies of indexes.final CompletableFuture<ShrinkResponse> Allow to shrink an existing index into a new index with fewer primary shards.shrink(ShrinkRequest request) Allow to shrink an existing index into a new index with fewer primary shards.simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder, ObjectBuilder<SimulateIndexTemplateRequest>> fn) Simulate matching the given index name against the index templates in the system.Simulate matching the given index name against the index templates in the system.simulateTemplate(Function<SimulateTemplateRequest.Builder, ObjectBuilder<SimulateTemplateRequest>> fn) Simulate resolving the given template name or body.simulateTemplate(SimulateTemplateRequest request) Simulate resolving the given template name or body.final CompletableFuture<SplitResponse> Allows you to split an existing index into a new index with more primary shards.split(SplitRequest request) Allows you to split an existing index into a new index with more primary shards.stats()Provides statistics on operations happening in an index.Provides statistics on operations happening in an index.stats(IndicesStatsRequest request) Provides statistics on operations happening in an index.Updates index aliases.Updates index aliases.updateAliases(UpdateAliasesRequest request) Updates index aliases.Allows a user to validate a potentially expensive query without executing it.Allows a user to validate a potentially expensive query without executing it.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
-
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:
IOExceptionOpenSearchException
-
addBlock
public final CompletableFuture<AddBlockResponse> addBlock(Function<AddBlockRequest.Builder, ObjectBuilder<AddBlockRequest>> fn) throws IOException, OpenSearchExceptionAdds a block to an index.- Parameters:
fn- a function that initializes a builder to create theAddBlockRequest- Throws:
IOExceptionOpenSearchException
-
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:
IOExceptionOpenSearchException
-
analyze
public final CompletableFuture<AnalyzeResponse> analyze(Function<AnalyzeRequest.Builder, ObjectBuilder<AnalyzeRequest>> fn) throws IOException, OpenSearchExceptionPerforms the analysis process on a text and return the tokens breakdown of the text.- Parameters:
fn- a function that initializes a builder to create theAnalyzeRequest- Throws:
IOExceptionOpenSearchException
-
analyze
Performs the analysis process on a text and return the tokens breakdown of the text.- Throws:
IOExceptionOpenSearchException
-
clearCache
public CompletableFuture<ClearCacheResponse> clearCache(ClearCacheRequest request) throws IOException, OpenSearchException Clears all or specific caches for one or more indexes.- Throws:
IOExceptionOpenSearchException
-
clearCache
public final CompletableFuture<ClearCacheResponse> clearCache(Function<ClearCacheRequest.Builder, ObjectBuilder<ClearCacheRequest>> fn) throws IOException, OpenSearchExceptionClears all or specific caches for one or more indexes.- Parameters:
fn- a function that initializes a builder to create theClearCacheRequest- Throws:
IOExceptionOpenSearchException
-
clearCache
public final CompletableFuture<ClearCacheResponse> clearCache() throws IOException, OpenSearchExceptionClears all or specific caches for one or more indexes.- Throws:
IOExceptionOpenSearchException
-
clone
public CompletableFuture<CloneIndexResponse> clone(CloneIndexRequest request) throws IOException, OpenSearchException Clones an index.- Throws:
IOExceptionOpenSearchException
-
clone
public final CompletableFuture<CloneIndexResponse> clone(Function<CloneIndexRequest.Builder, ObjectBuilder<CloneIndexRequest>> fn) throws IOException, OpenSearchExceptionClones an index.- Parameters:
fn- a function that initializes a builder to create theCloneIndexRequest- Throws:
IOExceptionOpenSearchException
-
close
public CompletableFuture<CloseIndexResponse> close(CloseIndexRequest request) throws IOException, OpenSearchException Closes an index.- Throws:
IOExceptionOpenSearchException
-
close
public final CompletableFuture<CloseIndexResponse> close(Function<CloseIndexRequest.Builder, ObjectBuilder<CloseIndexRequest>> fn) throws IOException, OpenSearchExceptionCloses an index.- Parameters:
fn- a function that initializes a builder to create theCloseIndexRequest- Throws:
IOExceptionOpenSearchException
-
create
public CompletableFuture<CreateIndexResponse> create(CreateIndexRequest request) throws IOException, OpenSearchException Creates an index with optional settings and mappings.- Throws:
IOExceptionOpenSearchException
-
create
public final CompletableFuture<CreateIndexResponse> create(Function<CreateIndexRequest.Builder, ObjectBuilder<CreateIndexRequest>> fn) throws IOException, OpenSearchExceptionCreates an index with optional settings and mappings.- Parameters:
fn- a function that initializes a builder to create theCreateIndexRequest- Throws:
IOExceptionOpenSearchException
-
createDataStream
public CompletableFuture<CreateDataStreamResponse> createDataStream(CreateDataStreamRequest request) throws IOException, OpenSearchException Creates or updates a data stream.- Throws:
IOExceptionOpenSearchException
-
createDataStream
public final CompletableFuture<CreateDataStreamResponse> createDataStream(Function<CreateDataStreamRequest.Builder, ObjectBuilder<CreateDataStreamRequest>> fn) throws IOException, OpenSearchExceptionCreates or updates a data stream.- Parameters:
fn- a function that initializes a builder to create theCreateDataStreamRequest- Throws:
IOExceptionOpenSearchException
-
dataStreamsStats
public CompletableFuture<DataStreamsStatsResponse> dataStreamsStats(DataStreamsStatsRequest request) throws IOException, OpenSearchException Provides statistics on operations happening in a data stream.- Throws:
IOExceptionOpenSearchException
-
dataStreamsStats
public final CompletableFuture<DataStreamsStatsResponse> dataStreamsStats(Function<DataStreamsStatsRequest.Builder, ObjectBuilder<DataStreamsStatsRequest>> fn) throws IOException, OpenSearchExceptionProvides statistics on operations happening in a data stream.- Parameters:
fn- a function that initializes a builder to create theDataStreamsStatsRequest- Throws:
IOExceptionOpenSearchException
-
dataStreamsStats
public final CompletableFuture<DataStreamsStatsResponse> dataStreamsStats() throws IOException, OpenSearchExceptionProvides statistics on operations happening in a data stream.- Throws:
IOExceptionOpenSearchException
-
delete
public CompletableFuture<DeleteIndexResponse> delete(DeleteIndexRequest request) throws IOException, OpenSearchException Deletes an index.- Throws:
IOExceptionOpenSearchException
-
delete
public final CompletableFuture<DeleteIndexResponse> delete(Function<DeleteIndexRequest.Builder, ObjectBuilder<DeleteIndexRequest>> fn) throws IOException, OpenSearchExceptionDeletes an index.- Parameters:
fn- a function that initializes a builder to create theDeleteIndexRequest- Throws:
IOExceptionOpenSearchException
-
deleteAlias
public CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest request) throws IOException, OpenSearchException Deletes an alias.- Throws:
IOExceptionOpenSearchException
-
deleteAlias
public final CompletableFuture<DeleteAliasResponse> deleteAlias(Function<DeleteAliasRequest.Builder, ObjectBuilder<DeleteAliasRequest>> fn) throws IOException, OpenSearchExceptionDeletes an alias.- Parameters:
fn- a function that initializes a builder to create theDeleteAliasRequest- Throws:
IOExceptionOpenSearchException
-
deleteDataStream
public CompletableFuture<DeleteDataStreamResponse> deleteDataStream(DeleteDataStreamRequest request) throws IOException, OpenSearchException Deletes a data stream.- Throws:
IOExceptionOpenSearchException
-
deleteDataStream
public final CompletableFuture<DeleteDataStreamResponse> deleteDataStream(Function<DeleteDataStreamRequest.Builder, ObjectBuilder<DeleteDataStreamRequest>> fn) throws IOException, OpenSearchExceptionDeletes a data stream.- Parameters:
fn- a function that initializes a builder to create theDeleteDataStreamRequest- Throws:
IOExceptionOpenSearchException
-
deleteIndexTemplate
public CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate(DeleteIndexTemplateRequest request) throws IOException, OpenSearchException Deletes an index template.- Throws:
IOExceptionOpenSearchException
-
deleteIndexTemplate
public final CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder, ObjectBuilder<DeleteIndexTemplateRequest>> fn) throws IOException, OpenSearchExceptionDeletes an index template.- Parameters:
fn- a function that initializes a builder to create theDeleteIndexTemplateRequest- Throws:
IOExceptionOpenSearchException
-
deleteTemplate
public CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest request) throws IOException, OpenSearchException Deletes an index template.- Throws:
IOExceptionOpenSearchException
-
deleteTemplate
public final CompletableFuture<DeleteTemplateResponse> deleteTemplate(Function<DeleteTemplateRequest.Builder, ObjectBuilder<DeleteTemplateRequest>> fn) throws IOException, OpenSearchExceptionDeletes an index template.- Parameters:
fn- a function that initializes a builder to create theDeleteTemplateRequest- Throws:
IOExceptionOpenSearchException
-
exists
public CompletableFuture<BooleanResponse> exists(ExistsRequest request) throws IOException, OpenSearchException Returns information about whether a particular index exists.- Throws:
IOExceptionOpenSearchException
-
exists
public final CompletableFuture<BooleanResponse> exists(Function<ExistsRequest.Builder, ObjectBuilder<ExistsRequest>> fn) throws IOException, OpenSearchExceptionReturns information about whether a particular index exists.- Parameters:
fn- a function that initializes a builder to create theExistsRequest- Throws:
IOExceptionOpenSearchException
-
existsAlias
public CompletableFuture<BooleanResponse> existsAlias(ExistsAliasRequest request) throws IOException, OpenSearchException Returns information about whether a particular alias exists.- Throws:
IOExceptionOpenSearchException
-
existsAlias
public final CompletableFuture<BooleanResponse> existsAlias(Function<ExistsAliasRequest.Builder, ObjectBuilder<ExistsAliasRequest>> fn) throws IOException, OpenSearchExceptionReturns information about whether a particular alias exists.- Parameters:
fn- a function that initializes a builder to create theExistsAliasRequest- Throws:
IOExceptionOpenSearchException
-
existsIndexTemplate
public CompletableFuture<BooleanResponse> existsIndexTemplate(ExistsIndexTemplateRequest request) throws IOException, OpenSearchException Returns information about whether a particular index template exists.- Throws:
IOExceptionOpenSearchException
-
existsIndexTemplate
public final CompletableFuture<BooleanResponse> existsIndexTemplate(Function<ExistsIndexTemplateRequest.Builder, ObjectBuilder<ExistsIndexTemplateRequest>> fn) throws IOException, OpenSearchExceptionReturns information about whether a particular index template exists.- Parameters:
fn- a function that initializes a builder to create theExistsIndexTemplateRequest- Throws:
IOExceptionOpenSearchException
-
existsTemplate
public CompletableFuture<BooleanResponse> existsTemplate(ExistsTemplateRequest request) throws IOException, OpenSearchException Returns information about whether a particular index template exists.- Throws:
IOExceptionOpenSearchException
-
existsTemplate
public final CompletableFuture<BooleanResponse> existsTemplate(Function<ExistsTemplateRequest.Builder, ObjectBuilder<ExistsTemplateRequest>> fn) throws IOException, OpenSearchExceptionReturns information about whether a particular index template exists.- Parameters:
fn- a function that initializes a builder to create theExistsTemplateRequest- Throws:
IOExceptionOpenSearchException
-
flush
public CompletableFuture<FlushResponse> flush(FlushRequest request) throws IOException, OpenSearchException Performs the flush operation on one or more indexes.- Throws:
IOExceptionOpenSearchException
-
flush
public final CompletableFuture<FlushResponse> flush(Function<FlushRequest.Builder, ObjectBuilder<FlushRequest>> fn) throws IOException, OpenSearchExceptionPerforms the flush operation on one or more indexes.- Parameters:
fn- a function that initializes a builder to create theFlushRequest- Throws:
IOExceptionOpenSearchException
-
flush
Performs the flush operation on one or more indexes.- Throws:
IOExceptionOpenSearchException
-
forcemerge
public CompletableFuture<ForcemergeResponse> forcemerge(ForcemergeRequest request) throws IOException, OpenSearchException Performs the force merge operation on one or more indexes.- Throws:
IOExceptionOpenSearchException
-
forcemerge
public final CompletableFuture<ForcemergeResponse> forcemerge(Function<ForcemergeRequest.Builder, ObjectBuilder<ForcemergeRequest>> fn) throws IOException, OpenSearchExceptionPerforms the force merge operation on one or more indexes.- Parameters:
fn- a function that initializes a builder to create theForcemergeRequest- Throws:
IOExceptionOpenSearchException
-
forcemerge
public final CompletableFuture<ForcemergeResponse> forcemerge() throws IOException, OpenSearchExceptionPerforms the force merge operation on one or more indexes.- Throws:
IOExceptionOpenSearchException
-
get
public CompletableFuture<GetIndexResponse> get(GetIndexRequest request) throws IOException, OpenSearchException Returns information about one or more indexes.- Throws:
IOExceptionOpenSearchException
-
get
public final CompletableFuture<GetIndexResponse> get(Function<GetIndexRequest.Builder, ObjectBuilder<GetIndexRequest>> fn) throws IOException, OpenSearchExceptionReturns information about one or more indexes.- Parameters:
fn- a function that initializes a builder to create theGetIndexRequest- Throws:
IOExceptionOpenSearchException
-
getAlias
public CompletableFuture<GetAliasResponse> getAlias(GetAliasRequest request) throws IOException, OpenSearchException Returns an alias.- Throws:
IOExceptionOpenSearchException
-
getAlias
public final CompletableFuture<GetAliasResponse> getAlias(Function<GetAliasRequest.Builder, ObjectBuilder<GetAliasRequest>> fn) throws IOException, OpenSearchExceptionReturns an alias.- Parameters:
fn- a function that initializes a builder to create theGetAliasRequest- Throws:
IOExceptionOpenSearchException
-
getAlias
Returns an alias.- Throws:
IOExceptionOpenSearchException
-
getDataStream
public CompletableFuture<GetDataStreamResponse> getDataStream(GetDataStreamRequest request) throws IOException, OpenSearchException Returns data streams.- Throws:
IOExceptionOpenSearchException
-
getDataStream
public final CompletableFuture<GetDataStreamResponse> getDataStream(Function<GetDataStreamRequest.Builder, ObjectBuilder<GetDataStreamRequest>> fn) throws IOException, OpenSearchExceptionReturns data streams.- Parameters:
fn- a function that initializes a builder to create theGetDataStreamRequest- Throws:
IOExceptionOpenSearchException
-
getDataStream
public final CompletableFuture<GetDataStreamResponse> getDataStream() throws IOException, OpenSearchExceptionReturns data streams.- Throws:
IOExceptionOpenSearchException
-
getIndexTemplate
public CompletableFuture<GetIndexTemplateResponse> getIndexTemplate(GetIndexTemplateRequest request) throws IOException, OpenSearchException Returns an index template.- Throws:
IOExceptionOpenSearchException
-
getIndexTemplate
public final CompletableFuture<GetIndexTemplateResponse> getIndexTemplate(Function<GetIndexTemplateRequest.Builder, ObjectBuilder<GetIndexTemplateRequest>> fn) throws IOException, OpenSearchExceptionReturns an index template.- Parameters:
fn- a function that initializes a builder to create theGetIndexTemplateRequest- Throws:
IOExceptionOpenSearchException
-
getIndexTemplate
public final CompletableFuture<GetIndexTemplateResponse> getIndexTemplate() throws IOException, OpenSearchExceptionReturns an index template.- Throws:
IOExceptionOpenSearchException
-
getMapping
public CompletableFuture<GetMappingResponse> getMapping(GetMappingRequest request) throws IOException, OpenSearchException Returns mappings for one or more indexes.- Throws:
IOExceptionOpenSearchException
-
getMapping
public final CompletableFuture<GetMappingResponse> getMapping(Function<GetMappingRequest.Builder, ObjectBuilder<GetMappingRequest>> fn) throws IOException, OpenSearchExceptionReturns mappings for one or more indexes.- Parameters:
fn- a function that initializes a builder to create theGetMappingRequest- Throws:
IOExceptionOpenSearchException
-
getMapping
public final CompletableFuture<GetMappingResponse> getMapping() throws IOException, OpenSearchExceptionReturns mappings for one or more indexes.- Throws:
IOExceptionOpenSearchException
-
getSettings
public CompletableFuture<GetIndicesSettingsResponse> getSettings(GetIndicesSettingsRequest request) throws IOException, OpenSearchException Returns settings for one or more indexes.- Throws:
IOExceptionOpenSearchException
-
getSettings
public final CompletableFuture<GetIndicesSettingsResponse> getSettings(Function<GetIndicesSettingsRequest.Builder, ObjectBuilder<GetIndicesSettingsRequest>> fn) throws IOException, OpenSearchExceptionReturns settings for one or more indexes.- Parameters:
fn- a function that initializes a builder to create theGetIndicesSettingsRequest- Throws:
IOExceptionOpenSearchException
-
getSettings
public final CompletableFuture<GetIndicesSettingsResponse> getSettings() throws IOException, OpenSearchExceptionReturns settings for one or more indexes.- Throws:
IOExceptionOpenSearchException
-
getTemplate
public CompletableFuture<GetTemplateResponse> getTemplate(GetTemplateRequest request) throws IOException, OpenSearchException Returns an index template.- Throws:
IOExceptionOpenSearchException
-
getTemplate
public final CompletableFuture<GetTemplateResponse> getTemplate(Function<GetTemplateRequest.Builder, ObjectBuilder<GetTemplateRequest>> fn) throws IOException, OpenSearchExceptionReturns an index template.- Parameters:
fn- a function that initializes a builder to create theGetTemplateRequest- Throws:
IOExceptionOpenSearchException
-
getTemplate
public final CompletableFuture<GetTemplateResponse> getTemplate() throws IOException, OpenSearchExceptionReturns an index template.- Throws:
IOExceptionOpenSearchException
-
open
public CompletableFuture<OpenResponse> open(OpenRequest request) throws IOException, OpenSearchException Opens an index.- Throws:
IOExceptionOpenSearchException
-
open
public final CompletableFuture<OpenResponse> open(Function<OpenRequest.Builder, ObjectBuilder<OpenRequest>> fn) throws IOException, OpenSearchExceptionOpens an index.- Parameters:
fn- a function that initializes a builder to create theOpenRequest- Throws:
IOExceptionOpenSearchException
-
putAlias
public CompletableFuture<PutAliasResponse> putAlias(PutAliasRequest request) throws IOException, OpenSearchException Creates or updates an alias.- Throws:
IOExceptionOpenSearchException
-
putAlias
public final CompletableFuture<PutAliasResponse> putAlias(Function<PutAliasRequest.Builder, ObjectBuilder<PutAliasRequest>> fn) throws IOException, OpenSearchExceptionCreates or updates an alias.- Parameters:
fn- a function that initializes a builder to create thePutAliasRequest- Throws:
IOExceptionOpenSearchException
-
putAlias
Creates or updates an alias.- Throws:
IOExceptionOpenSearchException
-
putIndexTemplate
public CompletableFuture<PutIndexTemplateResponse> putIndexTemplate(PutIndexTemplateRequest request) throws IOException, OpenSearchException Creates or updates an index template.- Throws:
IOExceptionOpenSearchException
-
putIndexTemplate
public final CompletableFuture<PutIndexTemplateResponse> putIndexTemplate(Function<PutIndexTemplateRequest.Builder, ObjectBuilder<PutIndexTemplateRequest>> fn) throws IOException, OpenSearchExceptionCreates or updates an index template.- Parameters:
fn- a function that initializes a builder to create thePutIndexTemplateRequest- Throws:
IOExceptionOpenSearchException
-
putMapping
public CompletableFuture<PutMappingResponse> putMapping(PutMappingRequest request) throws IOException, OpenSearchException Updates the index mappings.- Throws:
IOExceptionOpenSearchException
-
putMapping
public final CompletableFuture<PutMappingResponse> putMapping(Function<PutMappingRequest.Builder, ObjectBuilder<PutMappingRequest>> fn) throws IOException, OpenSearchExceptionUpdates the index mappings.- Parameters:
fn- a function that initializes a builder to create thePutMappingRequest- Throws:
IOExceptionOpenSearchException
-
putSettings
public CompletableFuture<PutIndicesSettingsResponse> putSettings(PutIndicesSettingsRequest request) throws IOException, OpenSearchException Updates the index settings.- Throws:
IOExceptionOpenSearchException
-
putSettings
public final CompletableFuture<PutIndicesSettingsResponse> putSettings(Function<PutIndicesSettingsRequest.Builder, ObjectBuilder<PutIndicesSettingsRequest>> fn) throws IOException, OpenSearchExceptionUpdates the index settings.- Parameters:
fn- a function that initializes a builder to create thePutIndicesSettingsRequest- Throws:
IOExceptionOpenSearchException
-
putTemplate
public CompletableFuture<PutTemplateResponse> putTemplate(PutTemplateRequest request) throws IOException, OpenSearchException Creates or updates an index template.- Throws:
IOExceptionOpenSearchException
-
putTemplate
public final CompletableFuture<PutTemplateResponse> putTemplate(Function<PutTemplateRequest.Builder, ObjectBuilder<PutTemplateRequest>> fn) throws IOException, OpenSearchExceptionCreates or updates an index template.- Parameters:
fn- a function that initializes a builder to create thePutTemplateRequest- Throws:
IOExceptionOpenSearchException
-
recovery
public CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request) throws IOException, OpenSearchException Returns information about ongoing index shard recoveries.- Throws:
IOExceptionOpenSearchException
-
recovery
public final CompletableFuture<RecoveryResponse> recovery(Function<RecoveryRequest.Builder, ObjectBuilder<RecoveryRequest>> fn) throws IOException, OpenSearchExceptionReturns information about ongoing index shard recoveries.- Parameters:
fn- a function that initializes a builder to create theRecoveryRequest- Throws:
IOExceptionOpenSearchException
-
recovery
Returns information about ongoing index shard recoveries.- Throws:
IOExceptionOpenSearchException
-
refresh
public CompletableFuture<RefreshResponse> refresh(RefreshRequest request) throws IOException, OpenSearchException Performs the refresh operation in one or more indexes.- Throws:
IOExceptionOpenSearchException
-
refresh
public final CompletableFuture<RefreshResponse> refresh(Function<RefreshRequest.Builder, ObjectBuilder<RefreshRequest>> fn) throws IOException, OpenSearchExceptionPerforms the refresh operation in one or more indexes.- Parameters:
fn- a function that initializes a builder to create theRefreshRequest- Throws:
IOExceptionOpenSearchException
-
refresh
Performs the refresh operation in one or more indexes.- Throws:
IOExceptionOpenSearchException
-
resolveIndex
public CompletableFuture<ResolveIndexResponse> resolveIndex(ResolveIndexRequest request) throws IOException, OpenSearchException Returns information about any matching indexes, aliases, and data streams.- Throws:
IOExceptionOpenSearchException
-
resolveIndex
public final CompletableFuture<ResolveIndexResponse> resolveIndex(Function<ResolveIndexRequest.Builder, ObjectBuilder<ResolveIndexRequest>> fn) throws IOException, OpenSearchExceptionReturns information about any matching indexes, aliases, and data streams.- Parameters:
fn- a function that initializes a builder to create theResolveIndexRequest- Throws:
IOExceptionOpenSearchException
-
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:
IOExceptionOpenSearchException
-
rollover
public final CompletableFuture<RolloverResponse> rollover(Function<RolloverRequest.Builder, ObjectBuilder<RolloverRequest>> fn) throws IOException, OpenSearchExceptionUpdates 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 theRolloverRequest- Throws:
IOExceptionOpenSearchException
-
segments
public CompletableFuture<SegmentsResponse> segments(SegmentsRequest request) throws IOException, OpenSearchException Provides low-level information about segments in a Lucene index.- Throws:
IOExceptionOpenSearchException
-
segments
public final CompletableFuture<SegmentsResponse> segments(Function<SegmentsRequest.Builder, ObjectBuilder<SegmentsRequest>> fn) throws IOException, OpenSearchExceptionProvides low-level information about segments in a Lucene index.- Parameters:
fn- a function that initializes a builder to create theSegmentsRequest- Throws:
IOExceptionOpenSearchException
-
segments
Provides low-level information about segments in a Lucene index.- Throws:
IOExceptionOpenSearchException
-
shardStores
public CompletableFuture<ShardStoresResponse> shardStores(ShardStoresRequest request) throws IOException, OpenSearchException Provides store information for shard copies of indexes.- Throws:
IOExceptionOpenSearchException
-
shardStores
public final CompletableFuture<ShardStoresResponse> shardStores(Function<ShardStoresRequest.Builder, ObjectBuilder<ShardStoresRequest>> fn) throws IOException, OpenSearchExceptionProvides store information for shard copies of indexes.- Parameters:
fn- a function that initializes a builder to create theShardStoresRequest- Throws:
IOExceptionOpenSearchException
-
shardStores
public final CompletableFuture<ShardStoresResponse> shardStores() throws IOException, OpenSearchExceptionProvides store information for shard copies of indexes.- Throws:
IOExceptionOpenSearchException
-
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:
IOExceptionOpenSearchException
-
shrink
public final CompletableFuture<ShrinkResponse> shrink(Function<ShrinkRequest.Builder, ObjectBuilder<ShrinkRequest>> fn) throws IOException, OpenSearchExceptionAllow to shrink an existing index into a new index with fewer primary shards.- Parameters:
fn- a function that initializes a builder to create theShrinkRequest- Throws:
IOExceptionOpenSearchException
-
simulateIndexTemplate
public CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate(SimulateIndexTemplateRequest request) throws IOException, OpenSearchException Simulate matching the given index name against the index templates in the system.- Throws:
IOExceptionOpenSearchException
-
simulateIndexTemplate
public final CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder, ObjectBuilder<SimulateIndexTemplateRequest>> fn) throws IOException, OpenSearchExceptionSimulate matching the given index name against the index templates in the system.- Parameters:
fn- a function that initializes a builder to create theSimulateIndexTemplateRequest- Throws:
IOExceptionOpenSearchException
-
simulateTemplate
public CompletableFuture<SimulateTemplateResponse> simulateTemplate(SimulateTemplateRequest request) throws IOException, OpenSearchException Simulate resolving the given template name or body.- Throws:
IOExceptionOpenSearchException
-
simulateTemplate
public final CompletableFuture<SimulateTemplateResponse> simulateTemplate(Function<SimulateTemplateRequest.Builder, ObjectBuilder<SimulateTemplateRequest>> fn) throws IOException, OpenSearchExceptionSimulate resolving the given template name or body.- Parameters:
fn- a function that initializes a builder to create theSimulateTemplateRequest- Throws:
IOExceptionOpenSearchException
-
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:
IOExceptionOpenSearchException
-
split
public final CompletableFuture<SplitResponse> split(Function<SplitRequest.Builder, ObjectBuilder<SplitRequest>> fn) throws IOException, OpenSearchExceptionAllows you to split an existing index into a new index with more primary shards.- Parameters:
fn- a function that initializes a builder to create theSplitRequest- Throws:
IOExceptionOpenSearchException
-
stats
public CompletableFuture<IndicesStatsResponse> stats(IndicesStatsRequest request) throws IOException, OpenSearchException Provides statistics on operations happening in an index.- Throws:
IOExceptionOpenSearchException
-
stats
public final CompletableFuture<IndicesStatsResponse> stats(Function<IndicesStatsRequest.Builder, ObjectBuilder<IndicesStatsRequest>> fn) throws IOException, OpenSearchExceptionProvides statistics on operations happening in an index.- Parameters:
fn- a function that initializes a builder to create theIndicesStatsRequest- Throws:
IOExceptionOpenSearchException
-
stats
public final CompletableFuture<IndicesStatsResponse> stats() throws IOException, OpenSearchExceptionProvides statistics on operations happening in an index.- Throws:
IOExceptionOpenSearchException
-
updateAliases
public CompletableFuture<UpdateAliasesResponse> updateAliases(UpdateAliasesRequest request) throws IOException, OpenSearchException Updates index aliases.- Throws:
IOExceptionOpenSearchException
-
updateAliases
public final CompletableFuture<UpdateAliasesResponse> updateAliases(Function<UpdateAliasesRequest.Builder, ObjectBuilder<UpdateAliasesRequest>> fn) throws IOException, OpenSearchExceptionUpdates index aliases.- Parameters:
fn- a function that initializes a builder to create theUpdateAliasesRequest- Throws:
IOExceptionOpenSearchException
-
updateAliases
public final CompletableFuture<UpdateAliasesResponse> updateAliases() throws IOException, OpenSearchExceptionUpdates index aliases.- Throws:
IOExceptionOpenSearchException
-
validateQuery
public CompletableFuture<ValidateQueryResponse> validateQuery(ValidateQueryRequest request) throws IOException, OpenSearchException Allows a user to validate a potentially expensive query without executing it.- Throws:
IOExceptionOpenSearchException
-
validateQuery
public final CompletableFuture<ValidateQueryResponse> validateQuery(Function<ValidateQueryRequest.Builder, ObjectBuilder<ValidateQueryRequest>> fn) throws IOException, OpenSearchExceptionAllows a user to validate a potentially expensive query without executing it.- Parameters:
fn- a function that initializes a builder to create theValidateQueryRequest- Throws:
IOExceptionOpenSearchException
-
validateQuery
public final CompletableFuture<ValidateQueryResponse> validateQuery() throws IOException, OpenSearchExceptionAllows a user to validate a potentially expensive query without executing it.- Throws:
IOExceptionOpenSearchException
-