Package org.opensearch.client.opensearch.api.indices

Class IndicesAsyncClient

java.lang.Object
org.opensearch.client.base.ApiClient<IndicesAsyncClient>
org.opensearch.client.opensearch.api.indices.IndicesAsyncClient
public class IndicesAsyncClient
extends ApiClient<IndicesAsyncClient>
Client for the indices namespace.

  • Constructor Details

  • Method Details

    • addBlock

      public java.util.concurrent.CompletableFuture<AddBlockResponse> addBlock​(AddBlockRequest request) throws java.io.IOException
      Adds a block to an index.
      Throws:
      java.io.IOException

    • addBlock

      public final java.util.concurrent.CompletableFuture<AddBlockResponse> addBlock​(java.util.function.Function<AddBlockRequest.Builder,​ObjectBuilder<AddBlockRequest>> fn) throws java.io.IOException
      Adds a block to an index.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • analyze

      public java.util.concurrent.CompletableFuture<AnalyzeResponse> analyze​(AnalyzeRequest request) throws java.io.IOException
      Performs the analysis process on a text and return the tokens breakdown of the text.
      Throws:
      java.io.IOException

    • analyze

      public final java.util.concurrent.CompletableFuture<AnalyzeResponse> analyze​(java.util.function.Function<AnalyzeRequest.Builder,​ObjectBuilder<AnalyzeRequest>> fn) throws java.io.IOException
      Performs the analysis process on a text and return the tokens breakdown of the text.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • clearCache

      public java.util.concurrent.CompletableFuture<ClearCacheResponse> clearCache​(ClearCacheRequest request) throws java.io.IOException
      Clears all or specific caches for one or more indices.
      Throws:
      java.io.IOException

    • clearCache

      public final java.util.concurrent.CompletableFuture<ClearCacheResponse> clearCache​(java.util.function.Function<ClearCacheRequest.Builder,​ObjectBuilder<ClearCacheRequest>> fn) throws java.io.IOException
      Clears all or specific caches for one or more indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • clone

      public java.util.concurrent.CompletableFuture<CloneResponse> clone​(CloneRequest request) throws java.io.IOException
      Clones an index
      Throws:
      java.io.IOException

    • clone

      public final java.util.concurrent.CompletableFuture<CloneResponse> clone​(java.util.function.Function<CloneRequest.Builder,​ObjectBuilder<CloneRequest>> fn) throws java.io.IOException
      Clones an index
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • close

      public java.util.concurrent.CompletableFuture<CloseResponse> close​(CloseRequest request) throws java.io.IOException
      Closes an index.
      Throws:
      java.io.IOException

    • close

      public final java.util.concurrent.CompletableFuture<CloseResponse> close​(java.util.function.Function<CloseRequest.Builder,​ObjectBuilder<CloseRequest>> fn) throws java.io.IOException
      Closes an index.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • create

      public java.util.concurrent.CompletableFuture<CreateResponse> create​(CreateRequest request) throws java.io.IOException
      Creates an index with optional settings and mappings.
      Throws:
      java.io.IOException

    • create

      public final java.util.concurrent.CompletableFuture<CreateResponse> create​(java.util.function.Function<CreateRequest.Builder,​ObjectBuilder<CreateRequest>> fn) throws java.io.IOException
      Creates an index with optional settings and mappings.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • delete

      public java.util.concurrent.CompletableFuture<DeleteResponse> delete​(DeleteRequest request) throws java.io.IOException
      Deletes an index.
      Throws:
      java.io.IOException

    • delete

      public final java.util.concurrent.CompletableFuture<DeleteResponse> delete​(java.util.function.Function<DeleteRequest.Builder,​ObjectBuilder<DeleteRequest>> fn) throws java.io.IOException
      Deletes an index.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • deleteAlias

      public java.util.concurrent.CompletableFuture<DeleteAliasResponse> deleteAlias​(DeleteAliasRequest request) throws java.io.IOException
      Deletes an alias.
      Throws:
      java.io.IOException

    • deleteAlias

      public final java.util.concurrent.CompletableFuture<DeleteAliasResponse> deleteAlias​(java.util.function.Function<DeleteAliasRequest.Builder,​ObjectBuilder<DeleteAliasRequest>> fn) throws java.io.IOException
      Deletes an alias.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • deleteIndexTemplate

      public java.util.concurrent.CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate​(DeleteIndexTemplateRequest request) throws java.io.IOException
      Deletes an index template.
      Throws:
      java.io.IOException

    • deleteIndexTemplate

      public final java.util.concurrent.CompletableFuture<DeleteIndexTemplateResponse> deleteIndexTemplate​(java.util.function.Function<DeleteIndexTemplateRequest.Builder,​ObjectBuilder<DeleteIndexTemplateRequest>> fn) throws java.io.IOException
      Deletes an index template.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • deleteTemplate

      public java.util.concurrent.CompletableFuture<DeleteTemplateResponse> deleteTemplate​(DeleteTemplateRequest request) throws java.io.IOException
      Deletes an index template.
      Throws:
      java.io.IOException

    • deleteTemplate

      public final java.util.concurrent.CompletableFuture<DeleteTemplateResponse> deleteTemplate​(java.util.function.Function<DeleteTemplateRequest.Builder,​ObjectBuilder<DeleteTemplateRequest>> fn) throws java.io.IOException
      Deletes an index template.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • exists

      public java.util.concurrent.CompletableFuture<BooleanResponse> exists​(ExistsRequest request) throws java.io.IOException
      Returns information about whether a particular index exists.
      Throws:
      java.io.IOException

    • exists

      public final java.util.concurrent.CompletableFuture<BooleanResponse> exists​(java.util.function.Function<ExistsRequest.Builder,​ObjectBuilder<ExistsRequest>> fn) throws java.io.IOException
      Returns information about whether a particular index exists.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • existsAlias

      public java.util.concurrent.CompletableFuture<BooleanResponse> existsAlias​(ExistsAliasRequest request) throws java.io.IOException
      Returns information about whether a particular alias exists.
      Throws:
      java.io.IOException

    • existsAlias

      public final java.util.concurrent.CompletableFuture<BooleanResponse> existsAlias​(java.util.function.Function<ExistsAliasRequest.Builder,​ObjectBuilder<ExistsAliasRequest>> fn) throws java.io.IOException
      Returns information about whether a particular alias exists.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • existsIndexTemplate

      public java.util.concurrent.CompletableFuture<BooleanResponse> existsIndexTemplate​(ExistsIndexTemplateRequest request) throws java.io.IOException
      Returns information about whether a particular index template exists.
      Throws:
      java.io.IOException

    • existsIndexTemplate

      public final java.util.concurrent.CompletableFuture<BooleanResponse> existsIndexTemplate​(java.util.function.Function<ExistsIndexTemplateRequest.Builder,​ObjectBuilder<ExistsIndexTemplateRequest>> fn) throws java.io.IOException
      Returns information about whether a particular index template exists.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • existsTemplate

      public java.util.concurrent.CompletableFuture<BooleanResponse> existsTemplate​(ExistsTemplateRequest request) throws java.io.IOException
      Returns information about whether a particular index template exists.
      Throws:
      java.io.IOException

    • existsTemplate

      public final java.util.concurrent.CompletableFuture<BooleanResponse> existsTemplate​(java.util.function.Function<ExistsTemplateRequest.Builder,​ObjectBuilder<ExistsTemplateRequest>> fn) throws java.io.IOException
      Returns information about whether a particular index template exists.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • existsType

      public java.util.concurrent.CompletableFuture<BooleanResponse> existsType​(ExistsTypeRequest request) throws java.io.IOException
      Returns information about whether a particular document type exists. (DEPRECATED)
      Throws:
      java.io.IOException

    • existsType

      public final java.util.concurrent.CompletableFuture<BooleanResponse> existsType​(java.util.function.Function<ExistsTypeRequest.Builder,​ObjectBuilder<ExistsTypeRequest>> fn) throws java.io.IOException
      Returns information about whether a particular document type exists. (DEPRECATED)
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • flush

      public java.util.concurrent.CompletableFuture<FlushResponse> flush​(FlushRequest request) throws java.io.IOException
      Performs the flush operation on one or more indices.
      Throws:
      java.io.IOException

    • flush

      public final java.util.concurrent.CompletableFuture<FlushResponse> flush​(java.util.function.Function<FlushRequest.Builder,​ObjectBuilder<FlushRequest>> fn) throws java.io.IOException
      Performs the flush operation on one or more indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • flushSynced

      public java.util.concurrent.CompletableFuture<FlushSyncedResponse> flushSynced​(FlushSyncedRequest request) throws java.io.IOException
      Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead
      Throws:
      java.io.IOException

    • flushSynced

      public final java.util.concurrent.CompletableFuture<FlushSyncedResponse> flushSynced​(java.util.function.Function<FlushSyncedRequest.Builder,​ObjectBuilder<FlushSyncedRequest>> fn) throws java.io.IOException
      Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • forcemerge

      public java.util.concurrent.CompletableFuture<ForcemergeResponse> forcemerge​(ForcemergeRequest request) throws java.io.IOException
      Performs the force merge operation on one or more indices.
      Throws:
      java.io.IOException

    • forcemerge

      public final java.util.concurrent.CompletableFuture<ForcemergeResponse> forcemerge​(java.util.function.Function<ForcemergeRequest.Builder,​ObjectBuilder<ForcemergeRequest>> fn) throws java.io.IOException
      Performs the force merge operation on one or more indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • get

      public java.util.concurrent.CompletableFuture<GetResponse> get​(GetRequest request) throws java.io.IOException
      Returns information about one or more indices.
      Throws:
      java.io.IOException

    • get

      public final java.util.concurrent.CompletableFuture<GetResponse> get​(java.util.function.Function<GetRequest.Builder,​ObjectBuilder<GetRequest>> fn) throws java.io.IOException
      Returns information about one or more indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • getAlias

      public java.util.concurrent.CompletableFuture<GetAliasResponse> getAlias​(GetAliasRequest request) throws java.io.IOException
      Returns an alias.
      Throws:
      java.io.IOException

    • getAlias

      public final java.util.concurrent.CompletableFuture<GetAliasResponse> getAlias​(java.util.function.Function<GetAliasRequest.Builder,​ObjectBuilder<GetAliasRequest>> fn) throws java.io.IOException
      Returns an alias.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • getFieldMapping

      public java.util.concurrent.CompletableFuture<GetFieldMappingResponse> getFieldMapping​(GetFieldMappingRequest request) throws java.io.IOException
      Returns mapping for one or more fields.
      Throws:
      java.io.IOException

    • getFieldMapping

      public final java.util.concurrent.CompletableFuture<GetFieldMappingResponse> getFieldMapping​(java.util.function.Function<GetFieldMappingRequest.Builder,​ObjectBuilder<GetFieldMappingRequest>> fn) throws java.io.IOException
      Returns mapping for one or more fields.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • getIndexTemplate

      public java.util.concurrent.CompletableFuture<GetIndexTemplateResponse> getIndexTemplate​(GetIndexTemplateRequest request) throws java.io.IOException
      Returns an index template.
      Throws:
      java.io.IOException

    • getIndexTemplate

      public final java.util.concurrent.CompletableFuture<GetIndexTemplateResponse> getIndexTemplate​(java.util.function.Function<GetIndexTemplateRequest.Builder,​ObjectBuilder<GetIndexTemplateRequest>> fn) throws java.io.IOException
      Returns an index template.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • getMapping

      public java.util.concurrent.CompletableFuture<GetMappingResponse> getMapping​(GetMappingRequest request) throws java.io.IOException
      Returns mappings for one or more indices.
      Throws:
      java.io.IOException

    • getMapping

      public final java.util.concurrent.CompletableFuture<GetMappingResponse> getMapping​(java.util.function.Function<GetMappingRequest.Builder,​ObjectBuilder<GetMappingRequest>> fn) throws java.io.IOException
      Returns mappings for one or more indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • getSettings

      public java.util.concurrent.CompletableFuture<GetSettingsResponse> getSettings​(GetSettingsRequest request) throws java.io.IOException
      Returns settings for one or more indices.
      Throws:
      java.io.IOException

    • getSettings

      public final java.util.concurrent.CompletableFuture<GetSettingsResponse> getSettings​(java.util.function.Function<GetSettingsRequest.Builder,​ObjectBuilder<GetSettingsRequest>> fn) throws java.io.IOException
      Returns settings for one or more indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • getTemplate

      public java.util.concurrent.CompletableFuture<GetTemplateResponse> getTemplate​(GetTemplateRequest request) throws java.io.IOException
      Returns an index template.
      Throws:
      java.io.IOException

    • getTemplate

      public final java.util.concurrent.CompletableFuture<GetTemplateResponse> getTemplate​(java.util.function.Function<GetTemplateRequest.Builder,​ObjectBuilder<GetTemplateRequest>> fn) throws java.io.IOException
      Returns an index template.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • getUpgrade

      public java.util.concurrent.CompletableFuture<GetUpgradeResponse> getUpgrade​(GetUpgradeRequest request) throws java.io.IOException
      DEPRECATED Returns a progress status of current upgrade.
      Throws:
      java.io.IOException

    • getUpgrade

      public final java.util.concurrent.CompletableFuture<GetUpgradeResponse> getUpgrade​(java.util.function.Function<GetUpgradeRequest.Builder,​ObjectBuilder<GetUpgradeRequest>> fn) throws java.io.IOException
      DEPRECATED Returns a progress status of current upgrade.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • open

      public java.util.concurrent.CompletableFuture<OpenResponse> open​(OpenRequest request) throws java.io.IOException
      Opens an index.
      Throws:
      java.io.IOException

    • open

      public final java.util.concurrent.CompletableFuture<OpenResponse> open​(java.util.function.Function<OpenRequest.Builder,​ObjectBuilder<OpenRequest>> fn) throws java.io.IOException
      Opens an index.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • putAlias

      public java.util.concurrent.CompletableFuture<PutAliasResponse> putAlias​(PutAliasRequest request) throws java.io.IOException
      Creates or updates an alias.
      Throws:
      java.io.IOException

    • putAlias

      public final java.util.concurrent.CompletableFuture<PutAliasResponse> putAlias​(java.util.function.Function<PutAliasRequest.Builder,​ObjectBuilder<PutAliasRequest>> fn) throws java.io.IOException
      Creates or updates an alias.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • putIndexTemplate

      public java.util.concurrent.CompletableFuture<PutIndexTemplateResponse> putIndexTemplate​(PutIndexTemplateRequest request) throws java.io.IOException
      Creates or updates an index template.
      Throws:
      java.io.IOException

    • putIndexTemplate

      public final java.util.concurrent.CompletableFuture<PutIndexTemplateResponse> putIndexTemplate​(java.util.function.Function<PutIndexTemplateRequest.Builder,​ObjectBuilder<PutIndexTemplateRequest>> fn) throws java.io.IOException
      Creates or updates an index template.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • putMapping

      public java.util.concurrent.CompletableFuture<PutMappingResponse> putMapping​(PutMappingRequest request) throws java.io.IOException
      Updates the index mappings.
      Throws:
      java.io.IOException

    • putMapping

      public final java.util.concurrent.CompletableFuture<PutMappingResponse> putMapping​(java.util.function.Function<PutMappingRequest.Builder,​ObjectBuilder<PutMappingRequest>> fn) throws java.io.IOException
      Updates the index mappings.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • putSettings

      public java.util.concurrent.CompletableFuture<PutSettingsResponse> putSettings​(PutSettingsRequest request) throws java.io.IOException
      Updates the index settings.
      Throws:
      java.io.IOException

    • putSettings

      public final java.util.concurrent.CompletableFuture<PutSettingsResponse> putSettings​(java.util.function.Function<PutSettingsRequest.Builder,​ObjectBuilder<PutSettingsRequest>> fn) throws java.io.IOException
      Updates the index settings.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • putTemplate

      public java.util.concurrent.CompletableFuture<PutTemplateResponse> putTemplate​(PutTemplateRequest request) throws java.io.IOException
      Creates or updates an index template.
      Throws:
      java.io.IOException

    • putTemplate

      public final java.util.concurrent.CompletableFuture<PutTemplateResponse> putTemplate​(java.util.function.Function<PutTemplateRequest.Builder,​ObjectBuilder<PutTemplateRequest>> fn) throws java.io.IOException
      Creates or updates an index template.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • recovery

      public java.util.concurrent.CompletableFuture<RecoveryResponse> recovery​(RecoveryRequest request) throws java.io.IOException
      Returns information about ongoing index shard recoveries.
      Throws:
      java.io.IOException

    • recovery

      public final java.util.concurrent.CompletableFuture<RecoveryResponse> recovery​(java.util.function.Function<RecoveryRequest.Builder,​ObjectBuilder<RecoveryRequest>> fn) throws java.io.IOException
      Returns information about ongoing index shard recoveries.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • refresh

      public java.util.concurrent.CompletableFuture<RefreshResponse> refresh​(RefreshRequest request) throws java.io.IOException
      Performs the refresh operation in one or more indices.
      Throws:
      java.io.IOException

    • refresh

      public final java.util.concurrent.CompletableFuture<RefreshResponse> refresh​(java.util.function.Function<RefreshRequest.Builder,​ObjectBuilder<RefreshRequest>> fn) throws java.io.IOException
      Performs the refresh operation in one or more indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • resolveIndex

      public java.util.concurrent.CompletableFuture<ResolveIndexResponse> resolveIndex​(ResolveIndexRequest request) throws java.io.IOException
      Returns information about any matching indices, aliases, and data streams
      Throws:
      java.io.IOException

    • resolveIndex

      public final java.util.concurrent.CompletableFuture<ResolveIndexResponse> resolveIndex​(java.util.function.Function<ResolveIndexRequest.Builder,​ObjectBuilder<ResolveIndexRequest>> fn) throws java.io.IOException
      Returns information about any matching indices, aliases, and data streams
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • rollover

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

    • rollover

      public final java.util.concurrent.CompletableFuture<RolloverResponse> rollover​(java.util.function.Function<RolloverRequest.Builder,​ObjectBuilder<RolloverRequest>> fn) throws java.io.IOException
      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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • segments

      public java.util.concurrent.CompletableFuture<SegmentsResponse> segments​(SegmentsRequest request) throws java.io.IOException
      Provides low-level information about segments in a Lucene index.
      Throws:
      java.io.IOException

    • segments

      public final java.util.concurrent.CompletableFuture<SegmentsResponse> segments​(java.util.function.Function<SegmentsRequest.Builder,​ObjectBuilder<SegmentsRequest>> fn) throws java.io.IOException
      Provides low-level information about segments in a Lucene index.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • shardStores

      public java.util.concurrent.CompletableFuture<ShardStoresResponse> shardStores​(ShardStoresRequest request) throws java.io.IOException
      Provides store information for shard copies of indices.
      Throws:
      java.io.IOException

    • shardStores

      public final java.util.concurrent.CompletableFuture<ShardStoresResponse> shardStores​(java.util.function.Function<ShardStoresRequest.Builder,​ObjectBuilder<ShardStoresRequest>> fn) throws java.io.IOException
      Provides store information for shard copies of indices.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • shrink

      public java.util.concurrent.CompletableFuture<ShrinkResponse> shrink​(ShrinkRequest request) throws java.io.IOException
      Allow to shrink an existing index into a new index with fewer primary shards.
      Throws:
      java.io.IOException

    • shrink

      public final java.util.concurrent.CompletableFuture<ShrinkResponse> shrink​(java.util.function.Function<ShrinkRequest.Builder,​ObjectBuilder<ShrinkRequest>> fn) throws java.io.IOException
      Allow to shrink an existing index into a new index with fewer primary shards.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • simulateIndexTemplate

      public java.util.concurrent.CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate​(SimulateIndexTemplateRequest request) throws java.io.IOException
      Simulate matching the given index name against the index templates in the system
      Throws:
      java.io.IOException

    • simulateIndexTemplate

      public final java.util.concurrent.CompletableFuture<SimulateIndexTemplateResponse> simulateIndexTemplate​(java.util.function.Function<SimulateIndexTemplateRequest.Builder,​ObjectBuilder<SimulateIndexTemplateRequest>> fn) throws java.io.IOException
      Simulate matching the given index name against the index templates in the system
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • simulateTemplate

      public java.util.concurrent.CompletableFuture<SimulateTemplateResponse> simulateTemplate​(SimulateTemplateRequest request) throws java.io.IOException
      Simulate resolving the given template name or body
      Throws:
      java.io.IOException

    • simulateTemplate

      public final java.util.concurrent.CompletableFuture<SimulateTemplateResponse> simulateTemplate​(java.util.function.Function<SimulateTemplateRequest.Builder,​ObjectBuilder<SimulateTemplateRequest>> fn) throws java.io.IOException
      Simulate resolving the given template name or body
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • split

      public java.util.concurrent.CompletableFuture<SplitResponse> split​(SplitRequest request) throws java.io.IOException
      Allows you to split an existing index into a new index with more primary shards.
      Throws:
      java.io.IOException

    • split

      public final java.util.concurrent.CompletableFuture<SplitResponse> split​(java.util.function.Function<SplitRequest.Builder,​ObjectBuilder<SplitRequest>> fn) throws java.io.IOException
      Allows you to split an existing index into a new index with more primary shards.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • stats

      public java.util.concurrent.CompletableFuture<StatsResponse> stats​(StatsRequest request) throws java.io.IOException
      Provides statistics on operations happening in an index.
      Throws:
      java.io.IOException

    • stats

      public final java.util.concurrent.CompletableFuture<StatsResponse> stats​(java.util.function.Function<StatsRequest.Builder,​ObjectBuilder<StatsRequest>> fn) throws java.io.IOException
      Provides statistics on operations happening in an index.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • updateAliases

      public java.util.concurrent.CompletableFuture<UpdateAliasesResponse> updateAliases​(UpdateAliasesRequest request) throws java.io.IOException
      Updates index aliases.
      Throws:
      java.io.IOException

    • updateAliases

      public final java.util.concurrent.CompletableFuture<UpdateAliasesResponse> updateAliases​(java.util.function.Function<UpdateAliasesRequest.Builder,​ObjectBuilder<UpdateAliasesRequest>> fn) throws java.io.IOException
      Updates index aliases.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • upgrade

      public java.util.concurrent.CompletableFuture<UpgradeResponse> upgrade​(UpgradeRequest request) throws java.io.IOException
      DEPRECATED Upgrades to the current version of Lucene.
      Throws:
      java.io.IOException

    • upgrade

      public final java.util.concurrent.CompletableFuture<UpgradeResponse> upgrade​(java.util.function.Function<UpgradeRequest.Builder,​ObjectBuilder<UpgradeRequest>> fn) throws java.io.IOException
      DEPRECATED Upgrades to the current version of Lucene.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • validateQuery

      public java.util.concurrent.CompletableFuture<ValidateQueryResponse> validateQuery​(ValidateQueryRequest request) throws java.io.IOException
      Allows a user to validate a potentially expensive query without executing it.
      Throws:
      java.io.IOException

    • validateQuery

      public final java.util.concurrent.CompletableFuture<ValidateQueryResponse> validateQuery​(java.util.function.Function<ValidateQueryRequest.Builder,​ObjectBuilder<ValidateQueryRequest>> fn) throws java.io.IOException
      Allows a user to validate a potentially expensive query without executing it.
      Parameters:
      fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.
      Throws:
      java.io.IOException

    • withRequestOptions

      public IndicesAsyncClient withRequestOptions​(@Nullable org.opensearch.client.RequestOptions options)
      Creates a new IndicesAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.
      Specified by:
      withRequestOptions in class ApiClient<IndicesAsyncClient>

    • withRequestOptions

      public IndicesAsyncClient withRequestOptions​(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,​org.opensearch.client.RequestOptions.Builder> fn)
      Creates a new IndicesAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
      Parameters:
      fn - a function taking an options builder initialized with the current request options, or initialized with default values.