Package org.opensearch.client

Class IndicesClient

java.lang.Object
org.opensearch.client.IndicesClient
public final class IndicesClient extends Object
A wrapper for the RestHighLevelClient that provides methods for accessing the Indices API.

  • Method Summary

    Modifier and Type
    Method
    Description
    AnalyzeResponse
    analyze(AnalyzeRequest request, org.opensearch.client.RequestOptions options)
    Calls the analyze API
    org.opensearch.client.Cancellable
    analyzeAsync(AnalyzeRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<AnalyzeResponse> listener)
    Asynchronously calls the analyze API
    org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheResponse
    clearCache(org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheRequest clearIndicesCacheRequest, org.opensearch.client.RequestOptions options)
    Clears the cache of one or more indices using the Clear Cache API.
    org.opensearch.client.Cancellable
    clearCacheAsync(org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheRequest clearIndicesCacheRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheResponse> listener)
    Asynchronously clears the cache of one or more indices using the Clear Cache API.
    org.opensearch.action.admin.indices.shrink.ResizeResponse
    clone(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options)
    Deprecated.
    use clone(ResizeRequest, RequestOptions)
    ResizeResponse
    clone(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options)
    Clones an index using the Clone Index API.
    org.opensearch.client.Cancellable
    cloneAsync(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.shrink.ResizeResponse> listener)
    Deprecated.
    use cloneAsync(ResizeRequest, RequestOptions, ActionListener)
    org.opensearch.client.Cancellable
    cloneAsync(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<ResizeResponse> listener)
    Asynchronously clones an index using the Clone Index API.
    CloseIndexResponse
    close(CloseIndexRequest closeIndexRequest, org.opensearch.client.RequestOptions options)
    Closes an index using the Close Index API.
    org.opensearch.client.Cancellable
    closeAsync(CloseIndexRequest closeIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<CloseIndexResponse> listener)
    Asynchronously closes an index using the Close Index API.
    CreateIndexResponse
    create(CreateIndexRequest createIndexRequest, org.opensearch.client.RequestOptions options)
    Creates an index using the Create Index API.
    org.opensearch.client.Cancellable
    createAsync(CreateIndexRequest createIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<CreateIndexResponse> listener)
    Asynchronously creates an index using the Create Index API.
    org.opensearch.action.support.master.AcknowledgedResponse
    createDataStream(CreateDataStreamRequest createDataStreamRequest, org.opensearch.client.RequestOptions options)
    Creates a data stream using the Create Data Stream API.
    org.opensearch.client.Cancellable
    createDataStreamAsync(CreateDataStreamRequest createDataStreamRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously creates a data stream using the Create Data Stream API.
    DataStreamsStatsResponse
    dataStreamsStats(DataStreamsStatsRequest dataStreamsStatsRequest, org.opensearch.client.RequestOptions options)
    Gets statistics about one or more data streams using the Get Data Streams Stats API.
    org.opensearch.client.Cancellable
    dataStreamsStatsAsync(DataStreamsStatsRequest dataStreamsStatsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<DataStreamsStatsResponse> listener)
    Asynchronously gets statistics about one or more data streams using the Get Data Streams Stats API.
    org.opensearch.action.support.master.AcknowledgedResponse
    delete(org.opensearch.action.admin.indices.delete.DeleteIndexRequest deleteIndexRequest, org.opensearch.client.RequestOptions options)
    Deletes an index using the Delete Index API.
    AcknowledgedResponse
    deleteAlias(DeleteAliasRequest request, org.opensearch.client.RequestOptions options)
    Synchronously calls the delete alias api
    org.opensearch.client.Cancellable
    deleteAliasAsync(DeleteAliasRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)
    Asynchronously calls the delete alias api
    org.opensearch.client.Cancellable
    deleteAsync(org.opensearch.action.admin.indices.delete.DeleteIndexRequest deleteIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously deletes an index using the Delete Index API.
    org.opensearch.action.support.master.AcknowledgedResponse
    deleteDataStream(DeleteDataStreamRequest deleteDataStreamRequest, org.opensearch.client.RequestOptions options)
    Deletes a data stream using the Delete Data Stream API.
    org.opensearch.client.Cancellable
    deleteDataStreamAsync(DeleteDataStreamRequest deleteDataStreamRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously deletes a data stream using the Delete Data Stream API.
    org.opensearch.action.support.master.AcknowledgedResponse
    deleteIndexTemplate(DeleteComposableIndexTemplateRequest request, org.opensearch.client.RequestOptions options)
    Delete an index template using the Index Templates API
    org.opensearch.client.Cancellable
    deleteIndexTemplateAsync(DeleteComposableIndexTemplateRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously delete an index template using the Index Templates API
    org.opensearch.action.support.master.AcknowledgedResponse
    deleteTemplate(org.opensearch.action.admin.indices.template.delete.DeleteIndexTemplateRequest request, org.opensearch.client.RequestOptions options)
    Delete an index template using the Index Templates API
    org.opensearch.client.Cancellable
    deleteTemplateAsync(org.opensearch.action.admin.indices.template.delete.DeleteIndexTemplateRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously delete an index template using the Index Templates API
    boolean
    exists(GetIndexRequest request, org.opensearch.client.RequestOptions options)
    Checks if the index (indices) exists or not.
    boolean
    existsAlias(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options)
    Checks if one or more aliases exist using the Aliases Exist API.
    org.opensearch.client.Cancellable
    existsAliasAsync(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
    Asynchronously checks if one or more aliases exist using the Aliases Exist API.
    org.opensearch.client.Cancellable
    existsAsync(GetIndexRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
    Asynchronously checks if the index (indices) exists or not.
    boolean
    existsIndexTemplate(ComposableIndexTemplateExistRequest indexTemplatesRequest, org.opensearch.client.RequestOptions options)
    Uses the Index Templates API to determine if index templates exist
    org.opensearch.client.Cancellable
    existsIndexTemplateAsync(ComposableIndexTemplateExistRequest indexTemplatesExistRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
    Uses the Index Templates API to determine if index templates exist
    boolean
    existsTemplate(IndexTemplatesExistRequest indexTemplatesRequest, org.opensearch.client.RequestOptions options)
    Uses the Index Templates API to determine if index templates exist
    org.opensearch.client.Cancellable
    existsTemplateAsync(IndexTemplatesExistRequest indexTemplatesExistRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
    Uses the Index Templates API to determine if index templates exist
    org.opensearch.action.admin.indices.flush.FlushResponse
    flush(org.opensearch.action.admin.indices.flush.FlushRequest flushRequest, org.opensearch.client.RequestOptions options)
    Flush one or more indices using the Flush API.
    org.opensearch.client.Cancellable
    flushAsync(org.opensearch.action.admin.indices.flush.FlushRequest flushRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.flush.FlushResponse> listener)
    Asynchronously flush one or more indices using the Flush API.
    org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse
    forcemerge(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options)
    Force merge one or more indices using the Force Merge API.
    org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse
    forceMerge(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options)
    Deprecated.
    use forcemerge(ForceMergeRequest, RequestOptions) instead
    org.opensearch.client.Cancellable
    forcemergeAsync(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse> listener)
    Asynchronously force merge one or more indices using the Force Merge API.
    org.opensearch.client.Cancellable
    forceMergeAsync(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse> listener)
    Deprecated.
    use forcemergeAsync(ForceMergeRequest, RequestOptions, ActionListener) instead
    GetIndexResponse
    get(GetIndexRequest getIndexRequest, org.opensearch.client.RequestOptions options)
    Retrieve information about one or more indexes
    GetAliasesResponse
    getAlias(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options)
    Gets one or more aliases using the Get Index Aliases API.
    org.opensearch.client.Cancellable
    getAliasAsync(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetAliasesResponse> listener)
    Asynchronously gets one or more aliases using the Get Index Aliases API.
    org.opensearch.client.Cancellable
    getAsync(GetIndexRequest getIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetIndexResponse> listener)
    Retrieve information about one or more indexes
    GetDataStreamResponse
    getDataStream(GetDataStreamRequest dataStreamRequest, org.opensearch.client.RequestOptions options)
    Gets one or more data streams using the Get Data Stream API.
    org.opensearch.client.Cancellable
    getDataStreamAsync(GetDataStreamRequest dataStreamRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetDataStreamResponse> listener)
    Asynchronously gets one or more data streams using the Get Data Stream API.
    GetFieldMappingsResponse
    getFieldMapping(GetFieldMappingsRequest getFieldMappingsRequest, org.opensearch.client.RequestOptions options)
    Retrieves the field mappings on an index or indices using the Get Field Mapping API.
    org.opensearch.client.Cancellable
    getFieldMappingAsync(GetFieldMappingsRequest getFieldMappingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetFieldMappingsResponse> listener)
    Asynchronously retrieves the field mappings on an index or indices using the Get Field Mapping API.
    GetComposableIndexTemplatesResponse
    getIndexTemplate(GetComposableIndexTemplateRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options)
    Gets index templates using the Index Templates API
    GetIndexTemplatesResponse
    getIndexTemplate(GetIndexTemplatesRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options)
    Gets index templates using the Index Templates API
    org.opensearch.client.Cancellable
    getIndexTemplateAsync(GetComposableIndexTemplateRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetComposableIndexTemplatesResponse> listener)
    Asynchronously gets index templates using the Index Templates API
    org.opensearch.client.Cancellable
    getIndexTemplateAsync(GetIndexTemplatesRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetIndexTemplatesResponse> listener)
    Asynchronously gets index templates using the Index Templates API
    GetMappingsResponse
    getMapping(GetMappingsRequest getMappingsRequest, org.opensearch.client.RequestOptions options)
    Retrieves the mappings on an index or indices using the Get Mapping API.
    org.opensearch.client.Cancellable
    getMappingAsync(GetMappingsRequest getMappingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetMappingsResponse> listener)
    Asynchronously retrieves the mappings on an index on indices using the Get Mapping API.
    org.opensearch.action.admin.indices.settings.get.GetSettingsResponse
    getSettings(org.opensearch.action.admin.indices.settings.get.GetSettingsRequest getSettingsRequest, org.opensearch.client.RequestOptions options)
    Retrieve the settings of one or more indices.
    org.opensearch.client.Cancellable
    getSettingsAsync(org.opensearch.action.admin.indices.settings.get.GetSettingsRequest getSettingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.settings.get.GetSettingsResponse> listener)
    Asynchronously retrieve the settings of one or more indices.
    org.opensearch.action.admin.indices.open.OpenIndexResponse
    open(org.opensearch.action.admin.indices.open.OpenIndexRequest openIndexRequest, org.opensearch.client.RequestOptions options)
    Opens an index using the Open Index API.
    org.opensearch.client.Cancellable
    openAsync(org.opensearch.action.admin.indices.open.OpenIndexRequest openIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.open.OpenIndexResponse> listener)
    Asynchronously opens an index using the Open Index API.
    org.opensearch.action.support.master.AcknowledgedResponse
    putIndexTemplate(PutComposableIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options)
    Puts an index template using the Index Templates API.
    org.opensearch.client.Cancellable
    putIndexTemplateAsync(PutComposableIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously puts an index template using the Index Templates API.
    org.opensearch.action.support.master.AcknowledgedResponse
    putMapping(PutMappingRequest putMappingRequest, org.opensearch.client.RequestOptions options)
    Updates the mappings on an index using the Put Mapping API.
    org.opensearch.client.Cancellable
    putMappingAsync(PutMappingRequest putMappingRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously updates the mappings on an index using the Put Mapping API.
    org.opensearch.action.support.master.AcknowledgedResponse
    putSettings(org.opensearch.action.admin.indices.settings.put.UpdateSettingsRequest updateSettingsRequest, org.opensearch.client.RequestOptions options)
    Updates specific index level settings using the Update Indices Settings API.
    org.opensearch.client.Cancellable
    putSettingsAsync(org.opensearch.action.admin.indices.settings.put.UpdateSettingsRequest updateSettingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously updates specific index level settings using the Update Indices Settings API.
    org.opensearch.action.support.master.AcknowledgedResponse
    putTemplate(PutIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options)
    Puts an index template using the Index Templates API.
    org.opensearch.client.Cancellable
    putTemplateAsync(PutIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously puts an index template using the Index Templates API.
    org.opensearch.action.admin.indices.refresh.RefreshResponse
    refresh(org.opensearch.action.admin.indices.refresh.RefreshRequest refreshRequest, org.opensearch.client.RequestOptions options)
    Refresh one or more indices using the Refresh API.
    org.opensearch.client.Cancellable
    refreshAsync(org.opensearch.action.admin.indices.refresh.RefreshRequest refreshRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.refresh.RefreshResponse> listener)
    Asynchronously refresh one or more indices using the Refresh API.
    RolloverResponse
    rollover(RolloverRequest rolloverRequest, org.opensearch.client.RequestOptions options)
    Rolls over an index using the Rollover Index API.
    org.opensearch.client.Cancellable
    rolloverAsync(RolloverRequest rolloverRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<RolloverResponse> listener)
    Asynchronously rolls over an index using the Rollover Index API.
    org.opensearch.action.admin.indices.shrink.ResizeResponse
    shrink(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options)
    Deprecated.
    use shrink(ResizeRequest, RequestOptions)
    ResizeResponse
    shrink(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options)
    Shrinks an index using the Shrink Index API.
    org.opensearch.client.Cancellable
    shrinkAsync(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.shrink.ResizeResponse> listener)
    Deprecated.
    use shrinkAsync(ResizeRequest, RequestOptions, ActionListener)
    org.opensearch.client.Cancellable
    shrinkAsync(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<ResizeResponse> listener)
    Asynchronously shrinks an index using the Shrink index API.
    SimulateIndexTemplateResponse
    simulateIndexTemplate(SimulateIndexTemplateRequest simulateIndexTemplateRequest, org.opensearch.client.RequestOptions options)
    Simulates matching index name against the existing index templates in the system.
    org.opensearch.client.Cancellable
    simulateIndexTemplateAsync(SimulateIndexTemplateRequest simulateIndexTemplateRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<SimulateIndexTemplateResponse> listener)
    Asynchronously simulates matching index name against the existing index templates in the system.
    org.opensearch.action.admin.indices.shrink.ResizeResponse
    split(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options)
    Deprecated.
    use split(ResizeRequest, RequestOptions)
    ResizeResponse
    split(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options)
    Splits an index using the Split Index API.
    org.opensearch.client.Cancellable
    splitAsync(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.shrink.ResizeResponse> listener)
    Deprecated.
    use splitAsync(ResizeRequest, RequestOptions, ActionListener)
    org.opensearch.client.Cancellable
    splitAsync(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<ResizeResponse> listener)
    Asynchronously splits an index using the Split Index API.
    org.opensearch.action.support.master.AcknowledgedResponse
    updateAliases(org.opensearch.action.admin.indices.alias.IndicesAliasesRequest indicesAliasesRequest, org.opensearch.client.RequestOptions options)
    Updates aliases using the Index Aliases API.
    org.opensearch.client.Cancellable
    updateAliasesAsync(org.opensearch.action.admin.indices.alias.IndicesAliasesRequest indicesAliasesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously updates aliases using the Index Aliases API.
    org.opensearch.action.admin.indices.validate.query.ValidateQueryResponse
    validateQuery(org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest validateQueryRequest, org.opensearch.client.RequestOptions options)
    Validate a potentially expensive query without executing it.
    org.opensearch.client.Cancellable
    validateQueryAsync(org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest validateQueryRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.validate.query.ValidateQueryResponse> listener)
    Asynchronously validate a potentially expensive query without executing it.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • delete

      public org.opensearch.action.support.master.AcknowledgedResponse delete(org.opensearch.action.admin.indices.delete.DeleteIndexRequest deleteIndexRequest, org.opensearch.client.RequestOptions options) throws IOException
      Deletes an index using the Delete Index API.
      Parameters:
      deleteIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • deleteAsync

      public org.opensearch.client.Cancellable deleteAsync(org.opensearch.action.admin.indices.delete.DeleteIndexRequest deleteIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously deletes an index using the Delete Index API.
      Parameters:
      deleteIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • create

      public CreateIndexResponse create(CreateIndexRequest createIndexRequest, org.opensearch.client.RequestOptions options) throws IOException
      Creates an index using the Create Index API.
      Parameters:
      createIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • createAsync

      public org.opensearch.client.Cancellable createAsync(CreateIndexRequest createIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<CreateIndexResponse> listener)
      Asynchronously creates an index using the Create Index API.
      Parameters:
      createIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • createDataStream

      public org.opensearch.action.support.master.AcknowledgedResponse createDataStream(CreateDataStreamRequest createDataStreamRequest, org.opensearch.client.RequestOptions options) throws IOException
      Creates a data stream using the Create Data Stream API.
      Parameters:
      createDataStreamRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • createDataStreamAsync

      public org.opensearch.client.Cancellable createDataStreamAsync(CreateDataStreamRequest createDataStreamRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously creates a data stream using the Create Data Stream API.
      Parameters:
      createDataStreamRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • deleteDataStream

      public org.opensearch.action.support.master.AcknowledgedResponse deleteDataStream(DeleteDataStreamRequest deleteDataStreamRequest, org.opensearch.client.RequestOptions options) throws IOException
      Deletes a data stream using the Delete Data Stream API.
      Parameters:
      deleteDataStreamRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • deleteDataStreamAsync

      public org.opensearch.client.Cancellable deleteDataStreamAsync(DeleteDataStreamRequest deleteDataStreamRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously deletes a data stream using the Delete Data Stream API.
      Parameters:
      deleteDataStreamRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getDataStream

      public GetDataStreamResponse getDataStream(GetDataStreamRequest dataStreamRequest, org.opensearch.client.RequestOptions options) throws IOException
      Gets one or more data streams using the Get Data Stream API.
      Parameters:
      dataStreamRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getDataStreamAsync

      public org.opensearch.client.Cancellable getDataStreamAsync(GetDataStreamRequest dataStreamRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetDataStreamResponse> listener)
      Asynchronously gets one or more data streams using the Get Data Stream API.
      Parameters:
      dataStreamRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • dataStreamsStats

      public DataStreamsStatsResponse dataStreamsStats(DataStreamsStatsRequest dataStreamsStatsRequest, org.opensearch.client.RequestOptions options) throws IOException
      Gets statistics about one or more data streams using the Get Data Streams Stats API.
      Parameters:
      dataStreamsStatsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • dataStreamsStatsAsync

      public org.opensearch.client.Cancellable dataStreamsStatsAsync(DataStreamsStatsRequest dataStreamsStatsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<DataStreamsStatsResponse> listener)
      Asynchronously gets statistics about one or more data streams using the Get Data Streams Stats API.
      Parameters:
      dataStreamsStatsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • putMapping

      public org.opensearch.action.support.master.AcknowledgedResponse putMapping(PutMappingRequest putMappingRequest, org.opensearch.client.RequestOptions options) throws IOException
      Updates the mappings on an index using the Put Mapping API.
      Parameters:
      putMappingRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • putMappingAsync

      public org.opensearch.client.Cancellable putMappingAsync(PutMappingRequest putMappingRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously updates the mappings on an index using the Put Mapping API.
      Parameters:
      putMappingRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getMapping

      public GetMappingsResponse getMapping(GetMappingsRequest getMappingsRequest, org.opensearch.client.RequestOptions options) throws IOException
      Retrieves the mappings on an index or indices using the Get Mapping API.
      Parameters:
      getMappingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getMappingAsync

      public org.opensearch.client.Cancellable getMappingAsync(GetMappingsRequest getMappingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetMappingsResponse> listener)
      Asynchronously retrieves the mappings on an index on indices using the Get Mapping API.
      Parameters:
      getMappingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getFieldMapping

      public GetFieldMappingsResponse getFieldMapping(GetFieldMappingsRequest getFieldMappingsRequest, org.opensearch.client.RequestOptions options) throws IOException
      Retrieves the field mappings on an index or indices using the Get Field Mapping API.
      Parameters:
      getFieldMappingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getFieldMappingAsync

      public org.opensearch.client.Cancellable getFieldMappingAsync(GetFieldMappingsRequest getFieldMappingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetFieldMappingsResponse> listener)
      Asynchronously retrieves the field mappings on an index or indices using the Get Field Mapping API.
      Parameters:
      getFieldMappingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • updateAliases

      public org.opensearch.action.support.master.AcknowledgedResponse updateAliases(org.opensearch.action.admin.indices.alias.IndicesAliasesRequest indicesAliasesRequest, org.opensearch.client.RequestOptions options) throws IOException
      Updates aliases using the Index Aliases API.
      Parameters:
      indicesAliasesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • updateAliasesAsync

      public org.opensearch.client.Cancellable updateAliasesAsync(org.opensearch.action.admin.indices.alias.IndicesAliasesRequest indicesAliasesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously updates aliases using the Index Aliases API.
      Parameters:
      indicesAliasesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • open

      public org.opensearch.action.admin.indices.open.OpenIndexResponse open(org.opensearch.action.admin.indices.open.OpenIndexRequest openIndexRequest, org.opensearch.client.RequestOptions options) throws IOException
      Opens an index using the Open Index API.
      Parameters:
      openIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • openAsync

      public org.opensearch.client.Cancellable openAsync(org.opensearch.action.admin.indices.open.OpenIndexRequest openIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.open.OpenIndexResponse> listener)
      Asynchronously opens an index using the Open Index API.
      Parameters:
      openIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • close

      public CloseIndexResponse close(CloseIndexRequest closeIndexRequest, org.opensearch.client.RequestOptions options) throws IOException
      Closes an index using the Close Index API.
      Parameters:
      closeIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • closeAsync

      public org.opensearch.client.Cancellable closeAsync(CloseIndexRequest closeIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<CloseIndexResponse> listener)
      Asynchronously closes an index using the Close Index API.
      Parameters:
      closeIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • existsAlias

      public boolean existsAlias(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options) throws IOException
      Checks if one or more aliases exist using the Aliases Exist API.
      Parameters:
      getAliasesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request

    • existsAliasAsync

      public org.opensearch.client.Cancellable existsAliasAsync(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
      Asynchronously checks if one or more aliases exist using the Aliases Exist API.
      Parameters:
      getAliasesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • refresh

      public org.opensearch.action.admin.indices.refresh.RefreshResponse refresh(org.opensearch.action.admin.indices.refresh.RefreshRequest refreshRequest, org.opensearch.client.RequestOptions options) throws IOException
      Refresh one or more indices using the Refresh API.
      Parameters:
      refreshRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • refreshAsync

      public org.opensearch.client.Cancellable refreshAsync(org.opensearch.action.admin.indices.refresh.RefreshRequest refreshRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.refresh.RefreshResponse> listener)
      Asynchronously refresh one or more indices using the Refresh API.
      Parameters:
      refreshRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • flush

      public org.opensearch.action.admin.indices.flush.FlushResponse flush(org.opensearch.action.admin.indices.flush.FlushRequest flushRequest, org.opensearch.client.RequestOptions options) throws IOException
      Flush one or more indices using the Flush API.
      Parameters:
      flushRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • flushAsync

      public org.opensearch.client.Cancellable flushAsync(org.opensearch.action.admin.indices.flush.FlushRequest flushRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.flush.FlushResponse> listener)
      Asynchronously flush one or more indices using the Flush API.
      Parameters:
      flushRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getSettings

      public org.opensearch.action.admin.indices.settings.get.GetSettingsResponse getSettings(org.opensearch.action.admin.indices.settings.get.GetSettingsRequest getSettingsRequest, org.opensearch.client.RequestOptions options) throws IOException
      Retrieve the settings of one or more indices.
      Parameters:
      getSettingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getSettingsAsync

      public org.opensearch.client.Cancellable getSettingsAsync(org.opensearch.action.admin.indices.settings.get.GetSettingsRequest getSettingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.settings.get.GetSettingsResponse> listener)
      Asynchronously retrieve the settings of one or more indices.
      Parameters:
      getSettingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • get

      public GetIndexResponse get(GetIndexRequest getIndexRequest, org.opensearch.client.RequestOptions options) throws IOException
      Retrieve information about one or more indexes
      Parameters:
      getIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getAsync

      public org.opensearch.client.Cancellable getAsync(GetIndexRequest getIndexRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetIndexResponse> listener)
      Retrieve information about one or more indexes
      Parameters:
      getIndexRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • forceMerge

      @Deprecated public org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse forceMerge(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Deprecated.
      use forcemerge(ForceMergeRequest, RequestOptions) instead
      Force merge one or more indices using the Force Merge API.
      Parameters:
      forceMergeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • forcemerge

      public org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse forcemerge(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Force merge one or more indices using the Force Merge API.
      Parameters:
      forceMergeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • forceMergeAsync

      @Deprecated public org.opensearch.client.Cancellable forceMergeAsync(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse> listener)
      Deprecated.
      use forcemergeAsync(ForceMergeRequest, RequestOptions, ActionListener) instead
      Asynchronously force merge one or more indices using the Force Merge API.
      Parameters:
      forceMergeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • forcemergeAsync

      public org.opensearch.client.Cancellable forcemergeAsync(org.opensearch.action.admin.indices.forcemerge.ForceMergeRequest forceMergeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.forcemerge.ForceMergeResponse> listener)
      Asynchronously force merge one or more indices using the Force Merge API.
      Parameters:
      forceMergeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • clearCache

      public org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheResponse clearCache(org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheRequest clearIndicesCacheRequest, org.opensearch.client.RequestOptions options) throws IOException
      Clears the cache of one or more indices using the Clear Cache API.
      Parameters:
      clearIndicesCacheRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • clearCacheAsync

      public org.opensearch.client.Cancellable clearCacheAsync(org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheRequest clearIndicesCacheRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheResponse> listener)
      Asynchronously clears the cache of one or more indices using the Clear Cache API.
      Parameters:
      clearIndicesCacheRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • exists

      public boolean exists(GetIndexRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Checks if the index (indices) exists or not.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request

    • existsAsync

      public org.opensearch.client.Cancellable existsAsync(GetIndexRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
      Asynchronously checks if the index (indices) exists or not.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • shrink

      public ResizeResponse shrink(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Shrinks an index using the Shrink Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • shrink

      @Deprecated public org.opensearch.action.admin.indices.shrink.ResizeResponse shrink(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Deprecated.
      use shrink(ResizeRequest, RequestOptions)
      Shrinks an index using the Shrink Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • shrinkAsync

      public org.opensearch.client.Cancellable shrinkAsync(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<ResizeResponse> listener)
      Asynchronously shrinks an index using the Shrink index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • shrinkAsync

      @Deprecated public org.opensearch.client.Cancellable shrinkAsync(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.shrink.ResizeResponse> listener)
      Deprecated.
      use shrinkAsync(ResizeRequest, RequestOptions, ActionListener)
      Asynchronously shrinks an index using the Shrink index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • split

      public ResizeResponse split(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Splits an index using the Split Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • split

      @Deprecated public org.opensearch.action.admin.indices.shrink.ResizeResponse split(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Deprecated.
      use split(ResizeRequest, RequestOptions)
      Splits an index using the Split Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • splitAsync

      public org.opensearch.client.Cancellable splitAsync(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<ResizeResponse> listener)
      Asynchronously splits an index using the Split Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • splitAsync

      @Deprecated public org.opensearch.client.Cancellable splitAsync(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.shrink.ResizeResponse> listener)
      Deprecated.
      use splitAsync(ResizeRequest, RequestOptions, ActionListener)
      Asynchronously splits an index using the Split Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • clone

      public ResizeResponse clone(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Clones an index using the Clone Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • clone

      @Deprecated public org.opensearch.action.admin.indices.shrink.ResizeResponse clone(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options) throws IOException
      Deprecated.
      use clone(ResizeRequest, RequestOptions)
      Clones an index using the Clone Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • cloneAsync

      public org.opensearch.client.Cancellable cloneAsync(ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<ResizeResponse> listener)
      Asynchronously clones an index using the Clone Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • cloneAsync

      @Deprecated public org.opensearch.client.Cancellable cloneAsync(org.opensearch.action.admin.indices.shrink.ResizeRequest resizeRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.shrink.ResizeResponse> listener)
      Deprecated.
      use cloneAsync(ResizeRequest, RequestOptions, ActionListener)
      Asynchronously clones an index using the Clone Index API.
      Parameters:
      resizeRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • rollover

      public RolloverResponse rollover(RolloverRequest rolloverRequest, org.opensearch.client.RequestOptions options) throws IOException
      Rolls over an index using the Rollover Index API.
      Parameters:
      rolloverRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • rolloverAsync

      public org.opensearch.client.Cancellable rolloverAsync(RolloverRequest rolloverRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<RolloverResponse> listener)
      Asynchronously rolls over an index using the Rollover Index API.
      Parameters:
      rolloverRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getAlias

      public GetAliasesResponse getAlias(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options) throws IOException
      Gets one or more aliases using the Get Index Aliases API.
      Parameters:
      getAliasesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getAliasAsync

      public org.opensearch.client.Cancellable getAliasAsync(org.opensearch.action.admin.indices.alias.get.GetAliasesRequest getAliasesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetAliasesResponse> listener)
      Asynchronously gets one or more aliases using the Get Index Aliases API.
      Parameters:
      getAliasesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • putSettings

      public org.opensearch.action.support.master.AcknowledgedResponse putSettings(org.opensearch.action.admin.indices.settings.put.UpdateSettingsRequest updateSettingsRequest, org.opensearch.client.RequestOptions options) throws IOException
      Updates specific index level settings using the Update Indices Settings API.
      Parameters:
      updateSettingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • putSettingsAsync

      public org.opensearch.client.Cancellable putSettingsAsync(org.opensearch.action.admin.indices.settings.put.UpdateSettingsRequest updateSettingsRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously updates specific index level settings using the Update Indices Settings API.
      Parameters:
      updateSettingsRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • putTemplate

      public org.opensearch.action.support.master.AcknowledgedResponse putTemplate(PutIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options) throws IOException
      Puts an index template using the Index Templates API.
      Parameters:
      putIndexTemplateRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • putTemplateAsync

      public org.opensearch.client.Cancellable putTemplateAsync(PutIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously puts an index template using the Index Templates API.
      Parameters:
      putIndexTemplateRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • putIndexTemplate

      public org.opensearch.action.support.master.AcknowledgedResponse putIndexTemplate(PutComposableIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options) throws IOException
      Puts an index template using the Index Templates API.
      Parameters:
      putIndexTemplateRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • putIndexTemplateAsync

      public org.opensearch.client.Cancellable putIndexTemplateAsync(PutComposableIndexTemplateRequest putIndexTemplateRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously puts an index template using the Index Templates API.
      Parameters:
      putIndexTemplateRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • simulateIndexTemplate

      public SimulateIndexTemplateResponse simulateIndexTemplate(SimulateIndexTemplateRequest simulateIndexTemplateRequest, org.opensearch.client.RequestOptions options) throws IOException
      Simulates matching index name against the existing index templates in the system.
      Parameters:
      simulateIndexTemplateRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • simulateIndexTemplateAsync

      public org.opensearch.client.Cancellable simulateIndexTemplateAsync(SimulateIndexTemplateRequest simulateIndexTemplateRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<SimulateIndexTemplateResponse> listener)
      Asynchronously simulates matching index name against the existing index templates in the system.
      Parameters:
      simulateIndexTemplateRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • validateQuery

      public org.opensearch.action.admin.indices.validate.query.ValidateQueryResponse validateQuery(org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest validateQueryRequest, org.opensearch.client.RequestOptions options) throws IOException
      Validate a potentially expensive query without executing it.
      Parameters:
      validateQueryRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • validateQueryAsync

      public org.opensearch.client.Cancellable validateQueryAsync(org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest validateQueryRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.admin.indices.validate.query.ValidateQueryResponse> listener)
      Asynchronously validate a potentially expensive query without executing it.
      Parameters:
      validateQueryRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getIndexTemplate

      public GetComposableIndexTemplatesResponse getIndexTemplate(GetComposableIndexTemplateRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options) throws IOException
      Gets index templates using the Index Templates API
      Parameters:
      getIndexTemplatesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getIndexTemplateAsync

      public org.opensearch.client.Cancellable getIndexTemplateAsync(GetComposableIndexTemplateRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetComposableIndexTemplatesResponse> listener)
      Asynchronously gets index templates using the Index Templates API
      Parameters:
      getIndexTemplatesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getIndexTemplate

      public GetIndexTemplatesResponse getIndexTemplate(GetIndexTemplatesRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options) throws IOException
      Gets index templates using the Index Templates API
      Parameters:
      getIndexTemplatesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getIndexTemplateAsync

      public org.opensearch.client.Cancellable getIndexTemplateAsync(GetIndexTemplatesRequest getIndexTemplatesRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<GetIndexTemplatesResponse> listener)
      Asynchronously gets index templates using the Index Templates API
      Parameters:
      getIndexTemplatesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • existsTemplate

      public boolean existsTemplate(IndexTemplatesExistRequest indexTemplatesRequest, org.opensearch.client.RequestOptions options) throws IOException
      Uses the Index Templates API to determine if index templates exist
      Parameters:
      indexTemplatesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      true if any index templates in the request exist, false otherwise
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • existsTemplateAsync

      public org.opensearch.client.Cancellable existsTemplateAsync(IndexTemplatesExistRequest indexTemplatesExistRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
      Uses the Index Templates API to determine if index templates exist
      Parameters:
      indexTemplatesExistRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion. The listener will be called with the value true
      Returns:
      cancellable that may be used to cancel the request

    • existsIndexTemplate

      public boolean existsIndexTemplate(ComposableIndexTemplateExistRequest indexTemplatesRequest, org.opensearch.client.RequestOptions options) throws IOException
      Uses the Index Templates API to determine if index templates exist
      Parameters:
      indexTemplatesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      true if any index templates in the request exist, false otherwise
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • existsIndexTemplateAsync

      public org.opensearch.client.Cancellable existsIndexTemplateAsync(ComposableIndexTemplateExistRequest indexTemplatesExistRequest, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<Boolean> listener)
      Uses the Index Templates API to determine if index templates exist
      Parameters:
      indexTemplatesExistRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion. The listener will be called with the value true
      Returns:
      cancellable that may be used to cancel the request

    • analyze

      public AnalyzeResponse analyze(AnalyzeRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Calls the analyze API
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Throws:
      IOException

    • analyzeAsync

      public org.opensearch.client.Cancellable analyzeAsync(AnalyzeRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<AnalyzeResponse> listener)
      Asynchronously calls the analyze API
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • deleteTemplate

      public org.opensearch.action.support.master.AcknowledgedResponse deleteTemplate(org.opensearch.action.admin.indices.template.delete.DeleteIndexTemplateRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Delete an index template using the Index Templates API
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • deleteTemplateAsync

      public org.opensearch.client.Cancellable deleteTemplateAsync(org.opensearch.action.admin.indices.template.delete.DeleteIndexTemplateRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously delete an index template using the Index Templates API
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • deleteIndexTemplate

      public org.opensearch.action.support.master.AcknowledgedResponse deleteIndexTemplate(DeleteComposableIndexTemplateRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Delete an index template using the Index Templates API
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • deleteIndexTemplateAsync

      public org.opensearch.client.Cancellable deleteIndexTemplateAsync(DeleteComposableIndexTemplateRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously delete an index template using the Index Templates API
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • deleteAlias

      public AcknowledgedResponse deleteAlias(DeleteAliasRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Synchronously calls the delete alias api
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Throws:
      IOException

    • deleteAliasAsync

      public org.opensearch.client.Cancellable deleteAliasAsync(DeleteAliasRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously calls the delete alias api
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request