java.lang.Object
- org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchIndicesAsyncClient>
- - org.opensearch.client.opensearch.indices.OpenSearchIndicesAsyncClient

public class OpenSearchIndicesAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchIndicesAsyncClient>

Client for the indices namespace.

Field Summary
- Fields inherited from class org.opensearch.client.ApiClient
  transport, transportOptions

Constructor Summary

Constructors
Constructor	Description
`OpenSearchIndicesAsyncClient(OpenSearchTransport transport)`
`OpenSearchIndicesAsyncClient(OpenSearchTransport transport, TransportOptions transportOptions)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.concurrent.CompletableFuture<AddBlockResponse>`	`addBlock(java.util.function.Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)`	Adds a block to an index.
`java.util.concurrent.CompletableFuture<AddBlockResponse>`	`addBlock(AddBlockRequest request)`	Adds a block to an index.
`java.util.concurrent.CompletableFuture<AnalyzeResponse>`	`analyze()`	Performs the analysis process on a text and return the tokens breakdown of the text.
`java.util.concurrent.CompletableFuture<AnalyzeResponse>`	`analyze(java.util.function.Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)`	Performs the analysis process on a text and return the tokens breakdown of the text.
`java.util.concurrent.CompletableFuture<AnalyzeResponse>`	`analyze(AnalyzeRequest request)`	Performs the analysis process on a text and return the tokens breakdown of the text.
`java.util.concurrent.CompletableFuture<ClearCacheResponse>`	`clearCache()`	Clears all or specific caches for one or more indices.
`java.util.concurrent.CompletableFuture<ClearCacheResponse>`	`clearCache(java.util.function.Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)`	Clears all or specific caches for one or more indices.
`java.util.concurrent.CompletableFuture<ClearCacheResponse>`	`clearCache(ClearCacheRequest request)`	Clears all or specific caches for one or more indices.
`java.util.concurrent.CompletableFuture<CloneIndexResponse>`	`clone(java.util.function.Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)`	Clones an index
`java.util.concurrent.CompletableFuture<CloneIndexResponse>`	`clone(CloneIndexRequest request)`	Clones an index
`java.util.concurrent.CompletableFuture<CloseIndexResponse>`	`close(java.util.function.Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)`	Closes an index.
`java.util.concurrent.CompletableFuture<CloseIndexResponse>`	`close(CloseIndexRequest request)`	Closes an index.
`java.util.concurrent.CompletableFuture<CreateIndexResponse>`	`create(java.util.function.Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)`	Creates an index with optional settings and mappings.
`java.util.concurrent.CompletableFuture<CreateIndexResponse>`	`create(CreateIndexRequest request)`	Creates an index with optional settings and mappings.
`java.util.concurrent.CompletableFuture<CreateDataStreamResponse>`	`createDataStream(java.util.function.Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)`	Creates a data stream
`java.util.concurrent.CompletableFuture<CreateDataStreamResponse>`	`createDataStream(CreateDataStreamRequest request)`	Creates a data stream
`java.util.concurrent.CompletableFuture<DataStreamsStatsResponse>`	`dataStreamsStats()`	Returns statistics of data streams
`java.util.concurrent.CompletableFuture<DataStreamsStatsResponse>`	`dataStreamsStats(java.util.function.Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)`	Returns statistics of data streams
`java.util.concurrent.CompletableFuture<DataStreamsStatsResponse>`	`dataStreamsStats(DataStreamsStatsRequest request)`	Returns statistics of data streams
`java.util.concurrent.CompletableFuture<DeleteIndexResponse>`	`delete(java.util.function.Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)`	Deletes an index.
`java.util.concurrent.CompletableFuture<DeleteIndexResponse>`	`delete(DeleteIndexRequest request)`	Deletes an index.
`java.util.concurrent.CompletableFuture<DeleteAliasResponse>`	`deleteAlias(java.util.function.Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)`	Deletes an alias.
`java.util.concurrent.CompletableFuture<DeleteAliasResponse>`	`deleteAlias(DeleteAliasRequest request)`	Deletes an alias.
`java.util.concurrent.CompletableFuture<DeleteDataStreamResponse>`	`deleteDataStream(java.util.function.Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)`	Deletes one or more data streams and their backing indices.
`java.util.concurrent.CompletableFuture<DeleteDataStreamResponse>`	`deleteDataStream(DeleteDataStreamRequest request)`	Deletes one or more data streams and their backing indices.
`java.util.concurrent.CompletableFuture<DeleteIndexTemplateResponse>`	`deleteIndexTemplate(java.util.function.Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)`	Deletes an index template.
`java.util.concurrent.CompletableFuture<DeleteIndexTemplateResponse>`	`deleteIndexTemplate(DeleteIndexTemplateRequest request)`	Deletes an index template.
`java.util.concurrent.CompletableFuture<DeleteTemplateResponse>`	`deleteTemplate(java.util.function.Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)`	Deletes an index template.
`java.util.concurrent.CompletableFuture<DeleteTemplateResponse>`	`deleteTemplate(DeleteTemplateRequest request)`	Deletes an index template.
`java.util.concurrent.CompletableFuture<DiskUsageResponse>`	`diskUsage(java.util.function.Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> fn)`	Analyzes the disk usage of each field of an index or data stream
`java.util.concurrent.CompletableFuture<DiskUsageResponse>`	`diskUsage(DiskUsageRequest request)`	Analyzes the disk usage of each field of an index or data stream
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`exists(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)`	Returns information about whether a particular index exists.
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`exists(ExistsRequest request)`	Returns information about whether a particular index exists.
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`existsAlias(java.util.function.Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)`	Returns information about whether a particular alias exists.
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`existsAlias(ExistsAliasRequest request)`	Returns information about whether a particular alias exists.
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`existsIndexTemplate(java.util.function.Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)`	Returns information about whether a particular index template exists.
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`existsIndexTemplate(ExistsIndexTemplateRequest request)`	Returns information about whether a particular index template exists.
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`existsTemplate(java.util.function.Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)`	Returns information about whether a particular index template exists.
`java.util.concurrent.CompletableFuture<BooleanResponse>`	`existsTemplate(ExistsTemplateRequest request)`	Returns information about whether a particular index template exists.
`java.util.concurrent.CompletableFuture<FlushResponse>`	`flush()`	Performs the flush operation on one or more indices.
`java.util.concurrent.CompletableFuture<FlushResponse>`	`flush(java.util.function.Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)`	Performs the flush operation on one or more indices.
`java.util.concurrent.CompletableFuture<FlushResponse>`	`flush(FlushRequest request)`	Performs the flush operation on one or more indices.
`java.util.concurrent.CompletableFuture<ForcemergeResponse>`	`forcemerge()`	Performs the force merge operation on one or more indices.
`java.util.concurrent.CompletableFuture<ForcemergeResponse>`	`forcemerge(java.util.function.Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)`	Performs the force merge operation on one or more indices.
`java.util.concurrent.CompletableFuture<ForcemergeResponse>`	`forcemerge(ForcemergeRequest request)`	Performs the force merge operation on one or more indices.
`java.util.concurrent.CompletableFuture<GetIndexResponse>`	`get(java.util.function.Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)`	Returns information about one or more indices.
`java.util.concurrent.CompletableFuture<GetIndexResponse>`	`get(GetIndexRequest request)`	Returns information about one or more indices.
`java.util.concurrent.CompletableFuture<GetAliasResponse>`	`getAlias()`	Returns an alias.
`java.util.concurrent.CompletableFuture<GetAliasResponse>`	`getAlias(java.util.function.Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)`	Returns an alias.
`java.util.concurrent.CompletableFuture<GetAliasResponse>`	`getAlias(GetAliasRequest request)`	Returns an alias.
`java.util.concurrent.CompletableFuture<GetDataStreamResponse>`	`getDataStream()`	Returns information about one or more data streams.
`java.util.concurrent.CompletableFuture<GetDataStreamResponse>`	`getDataStream(java.util.function.Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)`	Returns information about one or more data streams.
`java.util.concurrent.CompletableFuture<GetDataStreamResponse>`	`getDataStream(GetDataStreamRequest request)`	Returns information about one or more data streams.
`java.util.concurrent.CompletableFuture<GetFieldMappingResponse>`	`getFieldMapping(java.util.function.Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)`	Returns mapping for one or more fields.
`java.util.concurrent.CompletableFuture<GetFieldMappingResponse>`	`getFieldMapping(GetFieldMappingRequest request)`	Returns mapping for one or more fields.
`java.util.concurrent.CompletableFuture<GetIndexTemplateResponse>`	`getIndexTemplate()`	Returns an index template.
`java.util.concurrent.CompletableFuture<GetIndexTemplateResponse>`	`getIndexTemplate(java.util.function.Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)`	Returns an index template.
`java.util.concurrent.CompletableFuture<GetIndexTemplateResponse>`	`getIndexTemplate(GetIndexTemplateRequest request)`	Returns an index template.
`java.util.concurrent.CompletableFuture<GetMappingResponse>`	`getMapping()`	Returns mappings for one or more indices.
`java.util.concurrent.CompletableFuture<GetMappingResponse>`	`getMapping(java.util.function.Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)`	Returns mappings for one or more indices.
`java.util.concurrent.CompletableFuture<GetMappingResponse>`	`getMapping(GetMappingRequest request)`	Returns mappings for one or more indices.
`java.util.concurrent.CompletableFuture<GetIndicesSettingsResponse>`	`getSettings()`	Returns settings for one or more indices.
`java.util.concurrent.CompletableFuture<GetIndicesSettingsResponse>`	`getSettings(java.util.function.Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)`	Returns settings for one or more indices.
`java.util.concurrent.CompletableFuture<GetIndicesSettingsResponse>`	`getSettings(GetIndicesSettingsRequest request)`	Returns settings for one or more indices.
`java.util.concurrent.CompletableFuture<GetTemplateResponse>`	`getTemplate()`	Returns an index template.
`java.util.concurrent.CompletableFuture<GetTemplateResponse>`	`getTemplate(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)`	Returns an index template.
`java.util.concurrent.CompletableFuture<GetTemplateResponse>`	`getTemplate(GetTemplateRequest request)`	Returns an index template.
`java.util.concurrent.CompletableFuture<GetUpgradeResponse>`	`getUpgrade()`	DEPRECATED Returns a progress status of current upgrade.
`java.util.concurrent.CompletableFuture<GetUpgradeResponse>`	`getUpgrade(java.util.function.Function<GetUpgradeRequest.Builder,ObjectBuilder<GetUpgradeRequest>> fn)`	DEPRECATED Returns a progress status of current upgrade.
`java.util.concurrent.CompletableFuture<GetUpgradeResponse>`	`getUpgrade(GetUpgradeRequest request)`	DEPRECATED Returns a progress status of current upgrade.
`java.util.concurrent.CompletableFuture<OpenResponse>`	`open(java.util.function.Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)`	Opens an index.
`java.util.concurrent.CompletableFuture<OpenResponse>`	`open(OpenRequest request)`	Opens an index.
`java.util.concurrent.CompletableFuture<PutAliasResponse>`	`putAlias(java.util.function.Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)`	Creates or updates an alias.
`java.util.concurrent.CompletableFuture<PutAliasResponse>`	`putAlias(PutAliasRequest request)`	Creates or updates an alias.
`java.util.concurrent.CompletableFuture<PutIndexTemplateResponse>`	`putIndexTemplate(java.util.function.Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)`	Creates or updates an index template.
`java.util.concurrent.CompletableFuture<PutIndexTemplateResponse>`	`putIndexTemplate(PutIndexTemplateRequest request)`	Creates or updates an index template.
`java.util.concurrent.CompletableFuture<PutMappingResponse>`	`putMapping(java.util.function.Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)`	Updates the index mappings.
`java.util.concurrent.CompletableFuture<PutMappingResponse>`	`putMapping(PutMappingRequest request)`	Updates the index mappings.
`java.util.concurrent.CompletableFuture<PutIndicesSettingsResponse>`	`putSettings()`	Updates the index settings.
`java.util.concurrent.CompletableFuture<PutIndicesSettingsResponse>`	`putSettings(java.util.function.Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)`	Updates the index settings.
`java.util.concurrent.CompletableFuture<PutIndicesSettingsResponse>`	`putSettings(PutIndicesSettingsRequest request)`	Updates the index settings.
`java.util.concurrent.CompletableFuture<PutTemplateResponse>`	`putTemplate(java.util.function.Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)`	Creates or updates an index template.
`java.util.concurrent.CompletableFuture<PutTemplateResponse>`	`putTemplate(PutTemplateRequest request)`	Creates or updates an index template.
`java.util.concurrent.CompletableFuture<RecoveryResponse>`	`recovery()`	Returns information about ongoing index shard recoveries.
`java.util.concurrent.CompletableFuture<RecoveryResponse>`	`recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)`	Returns information about ongoing index shard recoveries.
`java.util.concurrent.CompletableFuture<RecoveryResponse>`	`recovery(RecoveryRequest request)`	Returns information about ongoing index shard recoveries.
`java.util.concurrent.CompletableFuture<RefreshResponse>`	`refresh()`	Performs the refresh operation in one or more indices.
`java.util.concurrent.CompletableFuture<RefreshResponse>`	`refresh(java.util.function.Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)`	Performs the refresh operation in one or more indices.
`java.util.concurrent.CompletableFuture<RefreshResponse>`	`refresh(RefreshRequest request)`	Performs the refresh operation in one or more indices.
`java.util.concurrent.CompletableFuture<ResolveIndexResponse>`	`resolveIndex(java.util.function.Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)`	Returns information about any matching indices, aliases, and data streams
`java.util.concurrent.CompletableFuture<ResolveIndexResponse>`	`resolveIndex(ResolveIndexRequest request)`	Returns information about any matching indices, aliases, and data streams
`java.util.concurrent.CompletableFuture<RolloverResponse>`	`rollover(java.util.function.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.
`java.util.concurrent.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.
`java.util.concurrent.CompletableFuture<SegmentsResponse>`	`segments()`	Provides low-level information about segments in a Lucene index.
`java.util.concurrent.CompletableFuture<SegmentsResponse>`	`segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)`	Provides low-level information about segments in a Lucene index.
`java.util.concurrent.CompletableFuture<SegmentsResponse>`	`segments(SegmentsRequest request)`	Provides low-level information about segments in a Lucene index.
`java.util.concurrent.CompletableFuture<ShardStoresResponse>`	`shardStores()`	Provides store information for shard copies of indices.
`java.util.concurrent.CompletableFuture<ShardStoresResponse>`	`shardStores(java.util.function.Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)`	Provides store information for shard copies of indices.
`java.util.concurrent.CompletableFuture<ShardStoresResponse>`	`shardStores(ShardStoresRequest request)`	Provides store information for shard copies of indices.
`java.util.concurrent.CompletableFuture<ShrinkResponse>`	`shrink(java.util.function.Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)`	Allow to shrink an existing index into a new index with fewer primary shards.
`java.util.concurrent.CompletableFuture<ShrinkResponse>`	`shrink(ShrinkRequest request)`	Allow to shrink an existing index into a new index with fewer primary shards.
`java.util.concurrent.CompletableFuture<SimulateIndexTemplateResponse>`	`simulateIndexTemplate(java.util.function.Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)`	Simulate matching the given index name against the index templates in the system
`java.util.concurrent.CompletableFuture<SimulateIndexTemplateResponse>`	`simulateIndexTemplate(SimulateIndexTemplateRequest request)`	Simulate matching the given index name against the index templates in the system
`java.util.concurrent.CompletableFuture<SimulateTemplateResponse>`	`simulateTemplate()`	Simulate resolving the given template name or body
`java.util.concurrent.CompletableFuture<SimulateTemplateResponse>`	`simulateTemplate(java.util.function.Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)`	Simulate resolving the given template name or body
`java.util.concurrent.CompletableFuture<SimulateTemplateResponse>`	`simulateTemplate(SimulateTemplateRequest request)`	Simulate resolving the given template name or body
`java.util.concurrent.CompletableFuture<SplitResponse>`	`split(java.util.function.Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)`	Allows you to split an existing index into a new index with more primary shards.
`java.util.concurrent.CompletableFuture<SplitResponse>`	`split(SplitRequest request)`	Allows you to split an existing index into a new index with more primary shards.
`java.util.concurrent.CompletableFuture<IndicesStatsResponse>`	`stats()`	Provides statistics on operations happening in an index.
`java.util.concurrent.CompletableFuture<IndicesStatsResponse>`	`stats(java.util.function.Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)`	Provides statistics on operations happening in an index.
`java.util.concurrent.CompletableFuture<IndicesStatsResponse>`	`stats(IndicesStatsRequest request)`	Provides statistics on operations happening in an index.
`java.util.concurrent.CompletableFuture<UpdateAliasesResponse>`	`updateAliases()`	Updates index aliases.
`java.util.concurrent.CompletableFuture<UpdateAliasesResponse>`	`updateAliases(java.util.function.Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)`	Updates index aliases.
`java.util.concurrent.CompletableFuture<UpdateAliasesResponse>`	`updateAliases(UpdateAliasesRequest request)`	Updates index aliases.
`java.util.concurrent.CompletableFuture<UpgradeResponse>`	`upgrade()`	DEPRECATED Upgrades to the current version of Lucene.
`java.util.concurrent.CompletableFuture<UpgradeResponse>`	`upgrade(java.util.function.Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn)`	DEPRECATED Upgrades to the current version of Lucene.
`java.util.concurrent.CompletableFuture<UpgradeResponse>`	`upgrade(UpgradeRequest request)`	DEPRECATED Upgrades to the current version of Lucene.
`java.util.concurrent.CompletableFuture<ValidateQueryResponse>`	`validateQuery()`	Allows a user to validate a potentially expensive query without executing it.
`java.util.concurrent.CompletableFuture<ValidateQueryResponse>`	`validateQuery(java.util.function.Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)`	Allows a user to validate a potentially expensive query without executing it.
`java.util.concurrent.CompletableFuture<ValidateQueryResponse>`	`validateQuery(ValidateQueryRequest request)`	Allows a user to validate a potentially expensive query without executing it.
`OpenSearchIndicesAsyncClient`	`withTransportOptions(TransportOptions transportOptions)`	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient
_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenSearchIndicesAsyncClient

public OpenSearchIndicesAsyncClient(OpenSearchTransport transport)

OpenSearchIndicesAsyncClient

public OpenSearchIndicesAsyncClient(OpenSearchTransport transport,
                                    @Nullable
                                    TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchIndicesAsyncClient withTransportOptions(@Nullable
                                                         TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:: withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIndicesAsyncClient>

addBlock

public java.util.concurrent.CompletableFuture<AddBlockResponse> addBlock(AddBlockRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Adds a block to an index.

Throws:: java.io.IOException; OpenSearchException

addBlock

public final java.util.concurrent.CompletableFuture<AddBlockResponse> addBlock(java.util.function.Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Adds a block to an index.

Parameters:: fn - a function that initializes a builder to create the AddBlockRequest
Throws:: java.io.IOException; OpenSearchException

analyze

public java.util.concurrent.CompletableFuture<AnalyzeResponse> analyze(AnalyzeRequest request)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

analyze

public final java.util.concurrent.CompletableFuture<AnalyzeResponse> analyze(java.util.function.Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)
                                                                      throws java.io.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:: java.io.IOException; OpenSearchException

analyze

public java.util.concurrent.CompletableFuture<AnalyzeResponse> analyze()
                                                                throws java.io.IOException,
                                                                       OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

clearCache

public java.util.concurrent.CompletableFuture<ClearCacheResponse> clearCache(ClearCacheRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Clears all or specific caches for one or more indices.

Throws:: java.io.IOException; OpenSearchException

clearCache

public final java.util.concurrent.CompletableFuture<ClearCacheResponse> clearCache(java.util.function.Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Clears all or specific caches for one or more indices.

Parameters:: fn - a function that initializes a builder to create the ClearCacheRequest
Throws:: java.io.IOException; OpenSearchException

clearCache

public java.util.concurrent.CompletableFuture<ClearCacheResponse> clearCache()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Clears all or specific caches for one or more indices.

Throws:: java.io.IOException; OpenSearchException

clone

public java.util.concurrent.CompletableFuture<CloneIndexResponse> clone(CloneIndexRequest request)
                                                                 throws java.io.IOException,
                                                                        OpenSearchException

Clones an index

Throws:: java.io.IOException; OpenSearchException

clone

public final java.util.concurrent.CompletableFuture<CloneIndexResponse> clone(java.util.function.Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)
                                                                       throws java.io.IOException,
                                                                              OpenSearchException

Clones an index

Parameters:: fn - a function that initializes a builder to create the CloneIndexRequest
Throws:: java.io.IOException; OpenSearchException

close

public java.util.concurrent.CompletableFuture<CloseIndexResponse> close(CloseIndexRequest request)
                                                                 throws java.io.IOException,
                                                                        OpenSearchException

Closes an index.

Throws:: java.io.IOException; OpenSearchException

close

public final java.util.concurrent.CompletableFuture<CloseIndexResponse> close(java.util.function.Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)
                                                                       throws java.io.IOException,
                                                                              OpenSearchException

Closes an index.

Parameters:: fn - a function that initializes a builder to create the CloseIndexRequest
Throws:: java.io.IOException; OpenSearchException

create

public java.util.concurrent.CompletableFuture<CreateIndexResponse> create(CreateIndexRequest request)
                                                                   throws java.io.IOException,
                                                                          OpenSearchException

Creates an index with optional settings and mappings.

Throws:: java.io.IOException; OpenSearchException

create

public final java.util.concurrent.CompletableFuture<CreateIndexResponse> create(java.util.function.Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)
                                                                         throws java.io.IOException,
                                                                                OpenSearchException

Creates an index with optional settings and mappings.

Parameters:: fn - a function that initializes a builder to create the CreateIndexRequest
Throws:: java.io.IOException; OpenSearchException

createDataStream

public java.util.concurrent.CompletableFuture<CreateDataStreamResponse> createDataStream(CreateDataStreamRequest request)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Creates a data stream

Throws:: java.io.IOException; OpenSearchException

createDataStream

public java.util.concurrent.CompletableFuture<CreateDataStreamResponse> createDataStream(java.util.function.Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Creates a data stream

Parameters:: fn - a function that initializes a builder to create the CreateDataStreamRequest
Throws:: java.io.IOException; OpenSearchException

delete

public java.util.concurrent.CompletableFuture<DeleteIndexResponse> delete(DeleteIndexRequest request)
                                                                   throws java.io.IOException,
                                                                          OpenSearchException

Deletes an index.

Throws:: java.io.IOException; OpenSearchException

delete

public final java.util.concurrent.CompletableFuture<DeleteIndexResponse> delete(java.util.function.Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)
                                                                         throws java.io.IOException,
                                                                                OpenSearchException

Deletes an index.

Parameters:: fn - a function that initializes a builder to create the DeleteIndexRequest
Throws:: java.io.IOException; OpenSearchException

deleteDataStream

public java.util.concurrent.CompletableFuture<DeleteDataStreamResponse> deleteDataStream(DeleteDataStreamRequest request)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Deletes one or more data streams and their backing indices.

Throws:: java.io.IOException; OpenSearchException

deleteDataStream

public final java.util.concurrent.CompletableFuture<DeleteDataStreamResponse> deleteDataStream(java.util.function.Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)
                                                                                        throws java.io.IOException,
                                                                                               OpenSearchException

Deletes one or more data streams and their backing indices.

Parameters:: fn - a function that initializes a builder to create the DeleteDataStreamRequest
Throws:: java.io.IOException; OpenSearchException

deleteAlias

public java.util.concurrent.CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Deletes an alias.

Throws:: java.io.IOException; OpenSearchException

deleteAlias

public final java.util.concurrent.CompletableFuture<DeleteAliasResponse> deleteAlias(java.util.function.Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Deletes an alias.

Parameters:: fn - a function that initializes a builder to create the DeleteAliasRequest
Throws:: java.io.IOException; OpenSearchException

deleteIndexTemplate

public java.util.concurrent.CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate(DeleteIndexTemplateRequest request)
                                                                                        throws java.io.IOException,
                                                                                               OpenSearchException

Deletes an index template.

Throws:: java.io.IOException; OpenSearchException

deleteIndexTemplate

public final java.util.concurrent.CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate(java.util.function.Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)
                                                                                              throws java.io.IOException,
                                                                                                     OpenSearchException

Deletes an index template.

Parameters:: fn - a function that initializes a builder to create the DeleteIndexTemplateRequest
Throws:: java.io.IOException; OpenSearchException

deleteTemplate

public java.util.concurrent.CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest request)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Deletes an index template.

Throws:: java.io.IOException; OpenSearchException

deleteTemplate

public final java.util.concurrent.CompletableFuture<DeleteTemplateResponse> deleteTemplate(java.util.function.Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)
                                                                                    throws java.io.IOException,
                                                                                           OpenSearchException

Deletes an index template.

Parameters:: fn - a function that initializes a builder to create the DeleteTemplateRequest
Throws:: java.io.IOException; OpenSearchException

diskUsage

public java.util.concurrent.CompletableFuture<DiskUsageResponse> diskUsage(DiskUsageRequest request)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

diskUsage

public final java.util.concurrent.CompletableFuture<DiskUsageResponse> diskUsage(java.util.function.Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> fn)
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

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

Parameters:: fn - a function that initializes a builder to create the DiskUsageRequest
Throws:: java.io.IOException; OpenSearchException

exists

public java.util.concurrent.CompletableFuture<BooleanResponse> exists(ExistsRequest request)
                                                               throws java.io.IOException,
                                                                      OpenSearchException

Returns information about whether a particular index exists.

Throws:: java.io.IOException; OpenSearchException

exists

public final java.util.concurrent.CompletableFuture<BooleanResponse> exists(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)
                                                                     throws java.io.IOException,
                                                                            OpenSearchException

Returns information about whether a particular index exists.

Parameters:: fn - a function that initializes a builder to create the ExistsRequest
Throws:: java.io.IOException; OpenSearchException

existsAlias

public java.util.concurrent.CompletableFuture<BooleanResponse> existsAlias(ExistsAliasRequest request)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

Returns information about whether a particular alias exists.

Throws:: java.io.IOException; OpenSearchException

existsAlias

public final java.util.concurrent.CompletableFuture<BooleanResponse> existsAlias(java.util.function.Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Returns information about whether a particular alias exists.

Parameters:: fn - a function that initializes a builder to create the ExistsAliasRequest
Throws:: java.io.IOException; OpenSearchException

existsIndexTemplate

public java.util.concurrent.CompletableFuture<BooleanResponse> existsIndexTemplate(ExistsIndexTemplateRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Returns information about whether a particular index template exists.

Throws:: java.io.IOException; OpenSearchException

existsIndexTemplate

public final java.util.concurrent.CompletableFuture<BooleanResponse> existsIndexTemplate(java.util.function.Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Returns information about whether a particular index template exists.

Parameters:: fn - a function that initializes a builder to create the ExistsIndexTemplateRequest
Throws:: java.io.IOException; OpenSearchException

existsTemplate

public java.util.concurrent.CompletableFuture<BooleanResponse> existsTemplate(ExistsTemplateRequest request)
                                                                       throws java.io.IOException,
                                                                              OpenSearchException

Returns information about whether a particular index template exists.

Throws:: java.io.IOException; OpenSearchException

existsTemplate

public final java.util.concurrent.CompletableFuture<BooleanResponse> existsTemplate(java.util.function.Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)
                                                                             throws java.io.IOException,
                                                                                    OpenSearchException

Returns information about whether a particular index template exists.

Parameters:: fn - a function that initializes a builder to create the ExistsTemplateRequest
Throws:: java.io.IOException; OpenSearchException

flush

public java.util.concurrent.CompletableFuture<FlushResponse> flush(FlushRequest request)
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Performs the flush operation on one or more indices.

Throws:: java.io.IOException; OpenSearchException

flush

public final java.util.concurrent.CompletableFuture<FlushResponse> flush(java.util.function.Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Performs the flush operation on one or more indices.

Parameters:: fn - a function that initializes a builder to create the FlushRequest
Throws:: java.io.IOException; OpenSearchException

flush

public java.util.concurrent.CompletableFuture<FlushResponse> flush()
                                                            throws java.io.IOException,
                                                                   OpenSearchException

Performs the flush operation on one or more indices.

Throws:: java.io.IOException; OpenSearchException

forcemerge

public java.util.concurrent.CompletableFuture<ForcemergeResponse> forcemerge(ForcemergeRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Performs the force merge operation on one or more indices.

Throws:: java.io.IOException; OpenSearchException

forcemerge

public final java.util.concurrent.CompletableFuture<ForcemergeResponse> forcemerge(java.util.function.Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Performs the force merge operation on one or more indices.

Parameters:: fn - a function that initializes a builder to create the ForcemergeRequest
Throws:: java.io.IOException; OpenSearchException

forcemerge

public java.util.concurrent.CompletableFuture<ForcemergeResponse> forcemerge()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Performs the force merge operation on one or more indices.

Throws:: java.io.IOException; OpenSearchException

get

public java.util.concurrent.CompletableFuture<GetIndexResponse> get(GetIndexRequest request)
                                                             throws java.io.IOException,
                                                                    OpenSearchException

Returns information about one or more indices.

Throws:: java.io.IOException; OpenSearchException

get

public final java.util.concurrent.CompletableFuture<GetIndexResponse> get(java.util.function.Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)
                                                                   throws java.io.IOException,
                                                                          OpenSearchException

Returns information about one or more indices.

Parameters:: fn - a function that initializes a builder to create the GetIndexRequest
Throws:: java.io.IOException; OpenSearchException

getDataStream

public java.util.concurrent.CompletableFuture<GetDataStreamResponse> getDataStream(GetDataStreamRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Returns information about one or more data streams.

Throws:: java.io.IOException; OpenSearchException

getDataStream

public final java.util.concurrent.CompletableFuture<GetDataStreamResponse> getDataStream(java.util.function.Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Returns information about one or more data streams.

Parameters:: fn - a function that initializes a builder to create the GetDataStreamRequest
Throws:: java.io.IOException; OpenSearchException

getDataStream

public java.util.concurrent.CompletableFuture<GetDataStreamResponse> getDataStream()
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Returns information about one or more data streams.

Throws:: java.io.IOException; OpenSearchException

getAlias

public java.util.concurrent.CompletableFuture<GetAliasResponse> getAlias(GetAliasRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns an alias.

Throws:: java.io.IOException; OpenSearchException

getAlias

public final java.util.concurrent.CompletableFuture<GetAliasResponse> getAlias(java.util.function.Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Returns an alias.

Parameters:: fn - a function that initializes a builder to create the GetAliasRequest
Throws:: java.io.IOException; OpenSearchException

getAlias

public java.util.concurrent.CompletableFuture<GetAliasResponse> getAlias()
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns an alias.

Throws:: java.io.IOException; OpenSearchException

getFieldMapping

public java.util.concurrent.CompletableFuture<GetFieldMappingResponse> getFieldMapping(GetFieldMappingRequest request)
                                                                                throws java.io.IOException,
                                                                                       OpenSearchException

Returns mapping for one or more fields.

Throws:: java.io.IOException; OpenSearchException

getFieldMapping

public final java.util.concurrent.CompletableFuture<GetFieldMappingResponse> getFieldMapping(java.util.function.Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)
                                                                                      throws java.io.IOException,
                                                                                             OpenSearchException

Returns mapping for one or more fields.

Parameters:: fn - a function that initializes a builder to create the GetFieldMappingRequest
Throws:: java.io.IOException; OpenSearchException

getIndexTemplate

public java.util.concurrent.CompletableFuture<GetIndexTemplateResponse> getIndexTemplate(GetIndexTemplateRequest request)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Returns an index template.

Throws:: java.io.IOException; OpenSearchException

getIndexTemplate

public final java.util.concurrent.CompletableFuture<GetIndexTemplateResponse> getIndexTemplate(java.util.function.Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)
                                                                                        throws java.io.IOException,
                                                                                               OpenSearchException

Returns an index template.

Parameters:: fn - a function that initializes a builder to create the GetIndexTemplateRequest
Throws:: java.io.IOException; OpenSearchException

getIndexTemplate

public java.util.concurrent.CompletableFuture<GetIndexTemplateResponse> getIndexTemplate()
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Returns an index template.

Throws:: java.io.IOException; OpenSearchException

getMapping

public java.util.concurrent.CompletableFuture<GetMappingResponse> getMapping(GetMappingRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns mappings for one or more indices.

Throws:: java.io.IOException; OpenSearchException

getMapping

public final java.util.concurrent.CompletableFuture<GetMappingResponse> getMapping(java.util.function.Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Returns mappings for one or more indices.

Parameters:: fn - a function that initializes a builder to create the GetMappingRequest
Throws:: java.io.IOException; OpenSearchException

getMapping

public java.util.concurrent.CompletableFuture<GetMappingResponse> getMapping()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns mappings for one or more indices.

Throws:: java.io.IOException; OpenSearchException

getSettings

public java.util.concurrent.CompletableFuture<GetIndicesSettingsResponse> getSettings(GetIndicesSettingsRequest request)
                                                                               throws java.io.IOException,
                                                                                      OpenSearchException

Returns settings for one or more indices.

Throws:: java.io.IOException; OpenSearchException

getSettings

public final java.util.concurrent.CompletableFuture<GetIndicesSettingsResponse> getSettings(java.util.function.Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)
                                                                                     throws java.io.IOException,
                                                                                            OpenSearchException

Returns settings for one or more indices.

Parameters:: fn - a function that initializes a builder to create the GetIndicesSettingsRequest
Throws:: java.io.IOException; OpenSearchException

getSettings

public java.util.concurrent.CompletableFuture<GetIndicesSettingsResponse> getSettings()
                                                                               throws java.io.IOException,
                                                                                      OpenSearchException

Returns settings for one or more indices.

Throws:: java.io.IOException; OpenSearchException

getTemplate

public java.util.concurrent.CompletableFuture<GetTemplateResponse> getTemplate(GetTemplateRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Returns an index template.

Throws:: java.io.IOException; OpenSearchException

getTemplate

public final java.util.concurrent.CompletableFuture<GetTemplateResponse> getTemplate(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Returns an index template.

Parameters:: fn - a function that initializes a builder to create the GetTemplateRequest
Throws:: java.io.IOException; OpenSearchException

getTemplate

public java.util.concurrent.CompletableFuture<GetTemplateResponse> getTemplate()
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Returns an index template.

Throws:: java.io.IOException; OpenSearchException

getUpgrade

public java.util.concurrent.CompletableFuture<GetUpgradeResponse> getUpgrade(GetUpgradeRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

DEPRECATED Returns a progress status of current upgrade.

Throws:: java.io.IOException; OpenSearchException

getUpgrade

public final java.util.concurrent.CompletableFuture<GetUpgradeResponse> getUpgrade(java.util.function.Function<GetUpgradeRequest.Builder,ObjectBuilder<GetUpgradeRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

DEPRECATED Returns a progress status of current upgrade.

Parameters:: fn - a function that initializes a builder to create the GetUpgradeRequest
Throws:: java.io.IOException; OpenSearchException

getUpgrade

public java.util.concurrent.CompletableFuture<GetUpgradeResponse> getUpgrade()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

DEPRECATED Returns a progress status of current upgrade.

Throws:: java.io.IOException; OpenSearchException

open

public java.util.concurrent.CompletableFuture<OpenResponse> open(OpenRequest request)
                                                          throws java.io.IOException,
                                                                 OpenSearchException

Opens an index.

Throws:: java.io.IOException; OpenSearchException

open

public final java.util.concurrent.CompletableFuture<OpenResponse> open(java.util.function.Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Opens an index.

Parameters:: fn - a function that initializes a builder to create the OpenRequest
Throws:: java.io.IOException; OpenSearchException

putAlias

public java.util.concurrent.CompletableFuture<PutAliasResponse> putAlias(PutAliasRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Creates or updates an alias.

Throws:: java.io.IOException; OpenSearchException

putAlias

public final java.util.concurrent.CompletableFuture<PutAliasResponse> putAlias(java.util.function.Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Creates or updates an alias.

Parameters:: fn - a function that initializes a builder to create the PutAliasRequest
Throws:: java.io.IOException; OpenSearchException

putIndexTemplate

public java.util.concurrent.CompletableFuture<PutIndexTemplateResponse> putIndexTemplate(PutIndexTemplateRequest request)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Creates or updates an index template.

Throws:: java.io.IOException; OpenSearchException

putIndexTemplate

public final java.util.concurrent.CompletableFuture<PutIndexTemplateResponse> putIndexTemplate(java.util.function.Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)
                                                                                        throws java.io.IOException,
                                                                                               OpenSearchException

Creates or updates an index template.

Parameters:: fn - a function that initializes a builder to create the PutIndexTemplateRequest
Throws:: java.io.IOException; OpenSearchException

putMapping

public java.util.concurrent.CompletableFuture<PutMappingResponse> putMapping(PutMappingRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Updates the index mappings.

Throws:: java.io.IOException; OpenSearchException

putMapping

public final java.util.concurrent.CompletableFuture<PutMappingResponse> putMapping(java.util.function.Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Updates the index mappings.

Parameters:: fn - a function that initializes a builder to create the PutMappingRequest
Throws:: java.io.IOException; OpenSearchException

putSettings

public java.util.concurrent.CompletableFuture<PutIndicesSettingsResponse> putSettings(PutIndicesSettingsRequest request)
                                                                               throws java.io.IOException,
                                                                                      OpenSearchException

Updates the index settings.

Throws:: java.io.IOException; OpenSearchException

putSettings

public final java.util.concurrent.CompletableFuture<PutIndicesSettingsResponse> putSettings(java.util.function.Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)
                                                                                     throws java.io.IOException,
                                                                                            OpenSearchException

Updates the index settings.

Parameters:: fn - a function that initializes a builder to create the PutIndicesSettingsRequest
Throws:: java.io.IOException; OpenSearchException

putSettings

public java.util.concurrent.CompletableFuture<PutIndicesSettingsResponse> putSettings()
                                                                               throws java.io.IOException,
                                                                                      OpenSearchException

Updates the index settings.

Throws:: java.io.IOException; OpenSearchException

putTemplate

public java.util.concurrent.CompletableFuture<PutTemplateResponse> putTemplate(PutTemplateRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Creates or updates an index template.

Throws:: java.io.IOException; OpenSearchException

putTemplate

public final java.util.concurrent.CompletableFuture<PutTemplateResponse> putTemplate(java.util.function.Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Creates or updates an index template.

Parameters:: fn - a function that initializes a builder to create the PutTemplateRequest
Throws:: java.io.IOException; OpenSearchException

recovery

public java.util.concurrent.CompletableFuture<RecoveryResponse> recovery(RecoveryRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns information about ongoing index shard recoveries.

Throws:: java.io.IOException; OpenSearchException

recovery

public final java.util.concurrent.CompletableFuture<RecoveryResponse> recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Returns information about ongoing index shard recoveries.

Parameters:: fn - a function that initializes a builder to create the RecoveryRequest
Throws:: java.io.IOException; OpenSearchException

recovery

public java.util.concurrent.CompletableFuture<RecoveryResponse> recovery()
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

Returns information about ongoing index shard recoveries.

Throws:: java.io.IOException; OpenSearchException

refresh

public java.util.concurrent.CompletableFuture<RefreshResponse> refresh(RefreshRequest request)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Performs the refresh operation in one or more indices.

Throws:: java.io.IOException; OpenSearchException

refresh

public final java.util.concurrent.CompletableFuture<RefreshResponse> refresh(java.util.function.Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Performs the refresh operation in one or more indices.

Parameters:: fn - a function that initializes a builder to create the RefreshRequest
Throws:: java.io.IOException; OpenSearchException

refresh

public java.util.concurrent.CompletableFuture<RefreshResponse> refresh()
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Performs the refresh operation in one or more indices.

Throws:: java.io.IOException; OpenSearchException

resolveIndex

public java.util.concurrent.CompletableFuture<ResolveIndexResponse> resolveIndex(ResolveIndexRequest request)
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Returns information about any matching indices, aliases, and data streams

Throws:: java.io.IOException; OpenSearchException

resolveIndex

public final java.util.concurrent.CompletableFuture<ResolveIndexResponse> resolveIndex(java.util.function.Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)
                                                                                throws java.io.IOException,
                                                                                       OpenSearchException

Returns information about any matching indices, aliases, and data streams

Parameters:: fn - a function that initializes a builder to create the ResolveIndexRequest
Throws:: java.io.IOException; OpenSearchException

rollover

public java.util.concurrent.CompletableFuture<RolloverResponse> rollover(RolloverRequest request)
                                                                  throws java.io.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:: java.io.IOException; OpenSearchException

rollover

public final java.util.concurrent.CompletableFuture<RolloverResponse> rollover(java.util.function.Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)
                                                                        throws java.io.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:: java.io.IOException; OpenSearchException

segments

public java.util.concurrent.CompletableFuture<SegmentsResponse> segments(SegmentsRequest request)
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

segments

public final java.util.concurrent.CompletableFuture<SegmentsResponse> segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
                                                                        throws java.io.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:: java.io.IOException; OpenSearchException

segments

public java.util.concurrent.CompletableFuture<SegmentsResponse> segments()
                                                                  throws java.io.IOException,
                                                                         OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

shardStores

public java.util.concurrent.CompletableFuture<ShardStoresResponse> shardStores(ShardStoresRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Provides store information for shard copies of indices.

Throws:: java.io.IOException; OpenSearchException

shardStores

public final java.util.concurrent.CompletableFuture<ShardStoresResponse> shardStores(java.util.function.Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Provides store information for shard copies of indices.

Parameters:: fn - a function that initializes a builder to create the ShardStoresRequest
Throws:: java.io.IOException; OpenSearchException

shardStores

public java.util.concurrent.CompletableFuture<ShardStoresResponse> shardStores()
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Provides store information for shard copies of indices.

Throws:: java.io.IOException; OpenSearchException

shrink

public java.util.concurrent.CompletableFuture<ShrinkResponse> shrink(ShrinkRequest request)
                                                              throws java.io.IOException,
                                                                     OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

shrink

public final java.util.concurrent.CompletableFuture<ShrinkResponse> shrink(java.util.function.Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)
                                                                    throws java.io.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:: java.io.IOException; OpenSearchException

simulateIndexTemplate

public java.util.concurrent.CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate(SimulateIndexTemplateRequest request)
                                                                                            throws java.io.IOException,
                                                                                                   OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

simulateIndexTemplate

public final java.util.concurrent.CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate(java.util.function.Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)
                                                                                                  throws java.io.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:: java.io.IOException; OpenSearchException

simulateTemplate

public java.util.concurrent.CompletableFuture<SimulateTemplateResponse> simulateTemplate(SimulateTemplateRequest request)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Simulate resolving the given template name or body

Throws:: java.io.IOException; OpenSearchException

simulateTemplate

public final java.util.concurrent.CompletableFuture<SimulateTemplateResponse> simulateTemplate(java.util.function.Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)
                                                                                        throws java.io.IOException,
                                                                                               OpenSearchException

Simulate resolving the given template name or body

Parameters:: fn - a function that initializes a builder to create the SimulateTemplateRequest
Throws:: java.io.IOException; OpenSearchException

simulateTemplate

public java.util.concurrent.CompletableFuture<SimulateTemplateResponse> simulateTemplate()
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Simulate resolving the given template name or body

Throws:: java.io.IOException; OpenSearchException

split

public java.util.concurrent.CompletableFuture<SplitResponse> split(SplitRequest request)
                                                            throws java.io.IOException,
                                                                   OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

split

public final java.util.concurrent.CompletableFuture<SplitResponse> split(java.util.function.Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)
                                                                  throws java.io.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:: java.io.IOException; OpenSearchException

stats

public java.util.concurrent.CompletableFuture<IndicesStatsResponse> stats(IndicesStatsRequest request)
                                                                   throws java.io.IOException,
                                                                          OpenSearchException

Provides statistics on operations happening in an index.

Throws:: java.io.IOException; OpenSearchException

stats

public final java.util.concurrent.CompletableFuture<IndicesStatsResponse> stats(java.util.function.Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)
                                                                         throws java.io.IOException,
                                                                                OpenSearchException

Provides statistics on operations happening in an index.

Parameters:: fn - a function that initializes a builder to create the IndicesStatsRequest
Throws:: java.io.IOException; OpenSearchException

stats

public java.util.concurrent.CompletableFuture<IndicesStatsResponse> stats()
                                                                   throws java.io.IOException,
                                                                          OpenSearchException

Provides statistics on operations happening in an index.

Throws:: java.io.IOException; OpenSearchException

dataStreamsStats

public java.util.concurrent.CompletableFuture<DataStreamsStatsResponse> dataStreamsStats(DataStreamsStatsRequest request)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Returns statistics of data streams

Throws:: java.io.IOException; OpenSearchException

dataStreamsStats

public final java.util.concurrent.CompletableFuture<DataStreamsStatsResponse> dataStreamsStats(java.util.function.Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)
                                                                                        throws java.io.IOException,
                                                                                               OpenSearchException

Returns statistics of data streams

Parameters:: fn - a function that initializes a builder to create the DataStreamsStatsRequest
Throws:: java.io.IOException; OpenSearchException

dataStreamsStats

public java.util.concurrent.CompletableFuture<DataStreamsStatsResponse> dataStreamsStats()
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Returns statistics of data streams

Throws:: java.io.IOException; OpenSearchException

updateAliases

public java.util.concurrent.CompletableFuture<UpdateAliasesResponse> updateAliases(UpdateAliasesRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Updates index aliases.

Throws:: java.io.IOException; OpenSearchException

updateAliases

public final java.util.concurrent.CompletableFuture<UpdateAliasesResponse> updateAliases(java.util.function.Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Updates index aliases.

Parameters:: fn - a function that initializes a builder to create the UpdateAliasesRequest
Throws:: java.io.IOException; OpenSearchException

updateAliases

public java.util.concurrent.CompletableFuture<UpdateAliasesResponse> updateAliases()
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Updates index aliases.

Throws:: java.io.IOException; OpenSearchException

upgrade

public java.util.concurrent.CompletableFuture<UpgradeResponse> upgrade(UpgradeRequest request)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

DEPRECATED Upgrades to the current version of Lucene.

Throws:: java.io.IOException; OpenSearchException

upgrade

public final java.util.concurrent.CompletableFuture<UpgradeResponse> upgrade(java.util.function.Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

DEPRECATED Upgrades to the current version of Lucene.

Parameters:: fn - a function that initializes a builder to create the UpgradeRequest
Throws:: java.io.IOException; OpenSearchException

upgrade

public java.util.concurrent.CompletableFuture<UpgradeResponse> upgrade()
                                                                throws java.io.IOException,
                                                                       OpenSearchException

DEPRECATED Upgrades to the current version of Lucene.

Throws:: java.io.IOException; OpenSearchException

validateQuery

public java.util.concurrent.CompletableFuture<ValidateQueryResponse> validateQuery(ValidateQueryRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

validateQuery

public final java.util.concurrent.CompletableFuture<ValidateQueryResponse> validateQuery(java.util.function.Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)
                                                                                  throws java.io.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:: java.io.IOException; OpenSearchException

validateQuery

public java.util.concurrent.CompletableFuture<ValidateQueryResponse> validateQuery()
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

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

Throws:: java.io.IOException; OpenSearchException

Class OpenSearchIndicesAsyncClient

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

Constructor Summary

Method Summary

Methods inherited from class org.opensearch.client.ApiClient

Methods inherited from class java.lang.Object

Constructor Detail

OpenSearchIndicesAsyncClient

OpenSearchIndicesAsyncClient

Method Detail

withTransportOptions

addBlock

addBlock

analyze

analyze

analyze

clearCache

clearCache

clearCache

clone

clone

close

close

create

create

createDataStream

createDataStream

delete

delete

deleteDataStream

deleteDataStream

deleteAlias

deleteAlias

deleteIndexTemplate

deleteIndexTemplate

deleteTemplate

deleteTemplate

diskUsage

diskUsage

exists

exists

existsAlias

existsAlias

existsIndexTemplate

existsIndexTemplate

existsTemplate

existsTemplate

flush

flush

flush

forcemerge

forcemerge

forcemerge

get

get

getDataStream

getDataStream

getDataStream

getAlias

getAlias

getAlias

getFieldMapping

getFieldMapping

getIndexTemplate

getIndexTemplate

getIndexTemplate

getMapping

getMapping

getMapping

getSettings

getSettings

getSettings

getTemplate

getTemplate

getTemplate

getUpgrade

getUpgrade

getUpgrade

open