Package org.springframework.data.elasticsearch.core

Interface ReactiveIndexOperations

All Known Implementing Classes:
ReactiveIndicesTemplate
public interface ReactiveIndexOperations
Interface defining operations on indexes for the reactive stack.
Since:
4.1
Author:
Peter-Josef Meisch, George Popides

  • Method Details

    • create

      Mono<Boolean> create()
      Create an index.
      Returns:
      a Mono signalling successful operation completion or an error if eg. the index already exist.

    • create

      Mono<Boolean> create(Map<String,Object> settings)
      Create an index with the specified settings.
      Parameters:
      settings - index settings
      Returns:
      a Mono signalling successful operation completion or an error if eg. the index already exist.

    • create

      Mono<Boolean> create(Map<String,Object> settings, Document mapping)
      Create an index for given settings and mapping.
      Parameters:
      settings - the index settings
      mapping - the index mapping
      Returns:
      a Mono signalling successful operation completion or an error if eg. the index already exist.
      Since:
      4.2

    • createWithMapping

      Mono<Boolean> createWithMapping()
      Create an index with the settings and mapping defined for the entity this IndexOperations is bound to.
      Returns:
      a Mono signalling successful operation completion or an error if eg. the index already exist.
      Since:
      4.2

    • delete

      Mono<Boolean> delete()
      Delete an index.
      Returns:
      a Mono signalling operation completion or an error. If the index does not exist, a value of false is emitted.

    • exists

      Mono<Boolean> exists()
      checks if an index exists
      Returns:
      a Mono with the result of exist check

    • refresh

      Mono<Void> refresh()
      Refresh the index(es) this IndexOperations is bound to
      Returns:
      a Mono signalling operation completion.

    • createMapping

      Mono<Document> createMapping()
      Creates the index mapping for the entity this IndexOperations is bound to.
      Returns:
      mapping object

    • createMapping

      Mono<Document> createMapping(Class<?> clazz)
      Creates the index mapping for the given class
      Parameters:
      clazz - the clazz to create a mapping for
      Returns:
      a Mono with the mapping document

    • putMapping

      default Mono<Boolean> putMapping()
      Writes the mapping to the index for the class this IndexOperations is bound to.
      Returns:
      true if the mapping could be stored

    • putMapping

      Mono<Boolean> putMapping(Mono<Document> mapping)
      writes a mapping to the index
      Parameters:
      mapping - the Document with the mapping definitions
      Returns:
      true if the mapping could be stored

    • putMapping

      default Mono<Boolean> putMapping(Class<?> clazz)
      Creates the index mapping for the given class and writes it to the index.
      Parameters:
      clazz - the clazz to create a mapping for
      Returns:
      true if the mapping could be stored

    • getMapping

      Mono<Document> getMapping()
      Get mapping for the index targeted defined by this ReactiveIndexOperations
      Returns:
      the mapping

    • createSettings

      Mono<Settings> createSettings()
      Creates the index settings for the entity this IndexOperations is bound to.
      Returns:
      a settings document.
      Since:
      4.1

    • createSettings

      Mono<Settings> createSettings(Class<?> clazz)
      Creates the index settings from the annotations on the given class
      Parameters:
      clazz - the class to create the index settings from
      Returns:
      a settings document.
      Since:
      4.1

    • getSettings

      default Mono<Settings> getSettings()
      get the settings for the index
      Returns:
      a Mono with a Document containing the index settings

    • getSettings

      Mono<Settings> getSettings(boolean includeDefaults)
      get the settings for the index
      Parameters:
      includeDefaults - whether or not to include all the default settings
      Returns:
      a Mono with a Document containing the index settings

    • alias

      Mono<Boolean> alias(AliasActions aliasActions)
      Executes the given AliasActions.
      Parameters:
      aliasActions - the actions to execute
      Returns:
      if the operation is acknowledged by Elasticsearch
      Since:
      4.1

    • getAliases

      Mono<Map<String,Set<AliasData>>> getAliases(String... aliasNames)
      gets information about aliases
      Parameters:
      aliasNames - alias names, must not be null
      Returns:
      a Mono of Map from index names to AliasData for that index
      Since:
      4.1

    • getAliasesForIndex

      Mono<Map<String,Set<AliasData>>> getAliasesForIndex(String... indexNames)
      gets information about aliases
      Parameters:
      indexNames - alias names, must not be null
      Returns:
      a Mono of Map from index names to AliasData for that index
      Since:
      4.1

    • putTemplate

      @Deprecated Mono<Boolean> putTemplate(PutTemplateRequest putTemplateRequest)
      Deprecated.
      since 5.1, as the underlying Elasticsearch API is deprecated.
      Creates an index template using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
      Parameters:
      putTemplateRequest - template request parameters
      Returns:
      Mono of true if the template could be stored
      Since:
      4.1

    • putComponentTemplate

      Mono<Boolean> putComponentTemplate(PutComponentTemplateRequest putComponentTemplateRequest)
      Writes a component index template that can be used in a composable index template.
      Parameters:
      putComponentTemplateRequest - index template request parameters
      Returns:
      true if successful
      Since:
      5.1

    • getComponentTemplate

      Flux<TemplateResponse> getComponentTemplate(GetComponentTemplateRequest getComponentTemplateRequest)
      Get component template(s).
      Parameters:
      getComponentTemplateRequest - the getComponentTemplateRequest parameters
      Returns:
      a Flux of TemplateResponse
      Since:
      5.1

    • existsComponentTemplate

      Mono<Boolean> existsComponentTemplate(ExistsComponentTemplateRequest existsComponentTemplateRequest)
      Checks wether a component index template exists.
      Parameters:
      existsComponentTemplateRequest - the parameters for the request
      Returns:
      Mono with the value if the componentTemplate exists.
      Since:
      5.1

    • deleteComponentTemplate

      Mono<Boolean> deleteComponentTemplate(DeleteComponentTemplateRequest deleteComponentTemplateRequest)
      Deletes a component index template.
      Parameters:
      deleteComponentTemplateRequest - the parameters for the request
      Returns:
      Mono with the value if the request was acknowledged.
      Since:
      5.1

    • putIndexTemplate

      Mono<Boolean> putIndexTemplate(PutIndexTemplateRequest putIndexTemplateRequest)
      Creates an index template.
      Parameters:
      putIndexTemplateRequest - template request parameters
      Returns:
      true if successful
      Since:
      5.1

    • existsIndexTemplate

      default Mono<Boolean> existsIndexTemplate(String indexTemplateName)
      Checks if an index template exists.
      Parameters:
      indexTemplateName - the name of the index template
      Returns:
      Mono with the value if the index template exists.
      Since:
      5.1

    • existsIndexTemplate

      Mono<Boolean> existsIndexTemplate(ExistsIndexTemplateRequest existsIndexTemplateRequest)
      Checks if an index template exists.
      Parameters:
      existsIndexTemplateRequest - the parameters for the request
      Returns:
      Mono with the value if the index template exists.
      Since:
      5.1

    • getIndexTemplate

      default Flux<TemplateResponse> getIndexTemplate(String indexTemplateName)
      Get index template(s).
      Parameters:
      indexTemplateName - the name of the index template
      Returns:
      a Flux of TemplateResponse
      Since:
      5.1

    • getIndexTemplate

      Flux<TemplateResponse> getIndexTemplate(GetIndexTemplateRequest getIndexTemplateRequest)
      Get index template(s).
      Parameters:
      getIndexTemplateRequest -
      Returns:
      a Flux of TemplateResponse
      Since:
      5.1

    • deleteIndexTemplate

      default Mono<Boolean> deleteIndexTemplate(String indexTemplateName)
      Deletes an index template.
      Parameters:
      indexTemplateName - the name of the index template
      Returns:
      Mono with the value if the request was acknowledged.
      Since:
      5.1

    • deleteIndexTemplate

      Mono<Boolean> deleteIndexTemplate(DeleteIndexTemplateRequest deleteIndexTemplateRequest)
      Deletes an index template.
      Parameters:
      deleteIndexTemplateRequest - the parameters for the request
      Returns:
      Mono with the value if the request was acknowledged.
      Since:
      5.1

    • getTemplate

      @Deprecated default Mono<TemplateData> getTemplate(String templateName)
      Deprecated.
      since 5.1, as the underlying Elasticsearch API is deprecated.
      gets an index template using the legacy Elasticsearch interface.
      Parameters:
      templateName - the template name
      Returns:
      Mono of TemplateData, Mono.empty() if no template with the given name exists.
      Since:
      4.1

    • getTemplate

      @Deprecated Mono<TemplateData> getTemplate(GetTemplateRequest getTemplateRequest)
      Deprecated.
      since 5.1, as the underlying Elasticsearch API is deprecated.
      gets an index template using the legacy Elasticsearch interface.
      Parameters:
      getTemplateRequest - the request parameters
      Returns:
      Mono of TemplateData, Mono.empty() if no template with the given name exists.
      Since:
      4.1

    • existsTemplate

      @Deprecated default Mono<Boolean> existsTemplate(String templateName)
      Deprecated.
      since 5.1, as the underlying Elasticsearch API is deprecated.
      Checks if an index template exists using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
      Parameters:
      templateName - the template name
      Returns:
      Mono of true if the template exists
      Since:
      4.1

    • existsTemplate

      @Deprecated Mono<Boolean> existsTemplate(ExistsTemplateRequest existsTemplateRequest)
      Deprecated.
      since 5.1, as the underlying Elasticsearch API is deprecated.
      Checks if an index template exists using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
      Parameters:
      existsTemplateRequest - template request parameters
      Returns:
      Mono of true if the template exists
      Since:
      4.1

    • deleteTemplate

      @Deprecated default Mono<Boolean> deleteTemplate(String templateName)
      Deprecated.
      since 5.1, as the underlying Elasticsearch API is deprecated.
      Deletes an index template using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
      Parameters:
      templateName - the template name
      Returns:
      Mono of true if the template could be deleted
      Since:
      4.1

    • deleteTemplate

      @Deprecated Mono<Boolean> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
      Deprecated.
      since 5.1, as the underlying Elasticsearch API is deprecated.
      Deletes an index template using the legacy Elasticsearch interface (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)
      Parameters:
      deleteTemplateRequest - template request parameters
      Returns:
      Mono of true if the template could be deleted
      Since:
      4.1

    • getInformation

      default Flux<IndexInformation> getInformation()
      Gets the IndexInformation for the indices defined by getIndexCoordinates().
      Returns:
      a flux of IndexInformation
      Since:
      4.2

    • getInformation

      Flux<IndexInformation> getInformation(IndexCoordinates index)
      Gets the IndexInformation for the indices defined by getIndexCoordinates().
      Returns:
      a flux of IndexInformation
      Since:
      4.2

    • getIndexCoordinates

      IndexCoordinates getIndexCoordinates()
      get the current IndexCoordinates. These may change over time when the entity class has a SpEL constructed index name. When this IndexOperations is not bound to a class, the bound IndexCoordinates are returned.
      Returns:
      IndexCoordinates
      Since:
      4.1