インターフェース IndexOperations

すべての既知のサブインターフェース:
IndexOperationsAdapter
すべての既知の実装クラス:
IndicesTemplate

public interface IndexOperations
Elasticsearch インデックス API の操作。
IndexOperations は、ElasticsearchOperations.indexOps(IndexCoordinates) または ElasticsearchOperations.indexOps(Class) によってエンティティクラスまたは IndexCoordinate にバインドされます。
導入:
4.0
作成者:
Peter-Josef Meisch, Sascha Woo, George Popides
  • メソッドの詳細

    • create

      boolean create()
      インデックスを作成します。
      戻り値:
      インデックスが作成された場合は true
    • create

      boolean create(MapSE<StringSE,ObjectSE> settings)
      指定された設定のインデックスを作成します。
      パラメーター:
      settings - インデックス設定
      戻り値:
      インデックスが作成された場合は true
    • create

      boolean create(MapSE<StringSE,ObjectSE> settings, Document mapping)
      指定された設定とマッピングのインデックスを作成します。
      パラメーター:
      settings - インデックス設定
      mapping - インデックスマッピング
      戻り値:
      インデックスが作成された場合は true
      導入:
      4.2
    • createWithMapping

      boolean createWithMapping()
      この IndexOperations がバインドされているエンティティに対して定義された設定とマッピングを使用してインデックスを作成します。
      戻り値:
      インデックスが作成された場合は true
      導入:
      4.2
    • delete

      boolean delete()
      この IndexOperations がバインドされているインデックスを削除します
      戻り値:
      インデックスが削除された場合は true
    • exists

      boolean exists()
      この IndexOperations がバインドされているインデックスが存在するかどうかを確認します
      戻り値:
      インデックスが存在する場合は true
    • refresh

      void refresh()
      この IndexOperations がバインドされているインデックスをリフレッシュします
    • createMapping

      Document createMapping()
      この IndexOperations がバインドされているエンティティのインデックスマッピングを作成します。
      戻り値:
      マッピングオブジェクト
    • createMapping

      Document createMapping(ClassSE<?> clazz)
      指定されたクラスのインデックスマッピングを作成します
      パラメーター:
      clazz - マッピングを作成するための clazz
      戻り値:
      マッピングオブジェクト
    • putMapping

      default boolean putMapping()
      この IndexOperations がバインドされているクラスのインデックスへのマッピングを書き込みます。
      戻り値:
      マッピングを保存できる場合は true
      導入:
      4.1
    • putMapping

      boolean putMapping(Document mapping)
      インデックスへのマッピングを書き込む
      パラメーター:
      mapping - マッピング定義を含むドキュメント
      戻り値:
      マッピングを保存できる場合は true
    • putMapping

      default boolean putMapping(ClassSE<?> clazz)
      指定されたクラスのインデックスマッピングを作成し、それをインデックスに書き込みます。
      パラメーター:
      clazz - マッピングを作成するための clazz
      戻り値:
      マッピングを保存できる場合は true
      導入:
      4.1
    • getMapping

      MapSE<StringSE,ObjectSE> getMapping()
      クラスによって定義されたインデックスのマッピングを取得します。
      戻り値:
      マッピング
    • createSettings

      Settings createSettings()
      この IndexOperations がバインドされているエンティティのインデックス設定を作成します。
      戻り値:
      設定ドキュメント。
      導入:
      4.1
    • createSettings

      Settings createSettings(ClassSE<?> clazz)
      指定されたクラスのアノテーションからインデックス設定を作成します
      パラメーター:
      clazz - インデックス設定を作成するクラス
      戻り値:
      設定ドキュメント。
      導入:
      4.1
    • getSettings

      Settings getSettings()
      インデックス設定を取得します。
      戻り値:
      設定
    • getSettings

      Settings getSettings(boolean includeDefaults)
      インデックス設定を取得します。
      パラメーター:
      includeDefaults - すべてのデフォルト設定を含めるかどうか
      戻り値:
      設定
    • alias

      boolean alias(AliasActions aliasActions)
      指定された AliasActions を実行します。
      パラメーター:
      aliasActions - 実行するアクション
      戻り値:
      操作が Elasticsearch によって確認された場合
      導入:
      4.1
    • getAliases

      MapSE<StringSE,SetSE<AliasData>> getAliases(StringSE... aliasNames)
      エイリアスに関する情報を取得します
      パラメーター:
      aliasNames - エイリアス名は null であってはなりません
      戻り値:
      インデックス名からそのインデックスの AliasData への MapSE
      導入:
      4.1
    • getAliasesForIndex

      MapSE<StringSE,SetSE<AliasData>> getAliasesForIndex(StringSE... indexNames)
      エイリアスに関する情報を取得します
      パラメーター:
      indexNames - インデックス名は null であってはなりません
      戻り値:
      インデックス名からそのインデックスの AliasData への MapSE
      導入:
      4.1
    • putTemplate

      @DeprecatedSE boolean putTemplate(PutTemplateRequest putTemplateRequest)
      使用すべきではありません。
      5.1 以降、基盤となる Elasticsearch API は非推奨になりました。
      従来の Elasticsearch インターフェース (@see、https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)) を使用してインデックステンプレートを作成します。
      パラメーター:
      putTemplateRequest - テンプレートリクエストパラメーター
      戻り値:
      成功した場合は true
      導入:
      4.1
    • putIndexTemplate

      boolean putIndexTemplate(PutIndexTemplateRequest putIndexTemplateRequest)
      インデックステンプレートを作成する
      パラメーター:
      putIndexTemplateRequest - テンプレートリクエストパラメーター
      戻り値:
      成功した場合は true
      導入:
      5.1
    • putComponentTemplate

      boolean putComponentTemplate(PutComponentTemplateRequest putComponentTemplateRequest)
      構成可能なインデックステンプレートで使用できるコンポーネントインデックステンプレートを書き込みます。
      パラメーター:
      putComponentTemplateRequest - インデックステンプレートのリクエストパラメーター
      戻り値:
      成功した場合は true
      導入:
      5.1
    • existsComponentTemplate

      boolean existsComponentTemplate(ExistsComponentTemplateRequest existsComponentTemplateRequest)
      コンポーネントインデックステンプレートが存在するかどうかを確認します。
      パラメーター:
      existsComponentTemplateRequest - リクエストのパラメーター
      戻り値:
      componentTemplate が存在する場合は true です。
      導入:
      5.1
    • getComponentTemplate

      ListSE<TemplateResponse> getComponentTemplate(GetComponentTemplateRequest getComponentTemplateRequest)
      コンポーネントテンプレートを取得します。
      パラメーター:
      getComponentTemplateRequest - リクエストのパラメーター。ワイルドカード名を含めることができます
      戻り値:
      見つかった TemplateResponse は空である可能性があります
      導入:
      5.1
    • deleteComponentTemplate

      boolean deleteComponentTemplate(DeleteComponentTemplateRequest deleteComponentTemplateRequest)
      指定されたコンポーネントインデックステンプレートを削除します
      パラメーター:
      deleteComponentTemplateRequest - リクエストパラメーター
      戻り値:
      成功した場合は true。
      導入:
      5.1
    • getTemplate

      @DeprecatedSE @Nullable default TemplateData getTemplate(StringSE templateName)
      使用すべきではありません。
      5.1 以降、基盤となる Elasticsearch API は非推奨になりました。
      従来の Elasticsearch インターフェースを使用してインデックステンプレートを取得します。
      パラメーター:
      templateName - テンプレート名
      戻り値:
      TemplateData、指定された名前のテンプレートが存在しない場合は null。
      導入:
      4.1
    • getTemplate

      @DeprecatedSE @Nullable TemplateData getTemplate(GetTemplateRequest getTemplateRequest)
      使用すべきではありません。
      5.1 以降、基盤となる Elasticsearch API は非推奨になりました。
      従来の Elasticsearch インターフェースを使用してインデックステンプレートを取得します。
      パラメーター:
      getTemplateRequest - リクエストパラメーター
      戻り値:
      TemplateData、指定された名前のテンプレートが存在しない場合は null。
      導入:
      4.1
    • existsTemplate

      @DeprecatedSE default boolean existsTemplate(StringSE templateName)
      使用すべきではありません。
      5.1 以降、基盤となる Elasticsearch API は非推奨になりました。
      従来の Elasticsearch インターフェースを使用してインデックステンプレートが存在するかどうかを確認します。
      パラメーター:
      templateName - テンプレート名
      戻り値:
      インデックスが存在する場合は true
      導入:
      4.1
    • existsTemplate

      @DeprecatedSE boolean existsTemplate(ExistsTemplateRequest existsTemplateRequest)
      使用すべきではありません。
      5.1 以降、基盤となる Elasticsearch API は非推奨になりました。
      従来の Elasticsearch インターフェースを使用してインデックステンプレートが存在するかどうかを確認します。
      パラメーター:
      existsTemplateRequest - リクエストパラメーター
      戻り値:
      インデックスが存在する場合は true
      導入:
      4.1
    • existsIndexTemplate

      default boolean existsIndexTemplate(StringSE templateName)
      インデックステンプレートが存在するかどうかを確認します。
      パラメーター:
      templateName - テンプレート名
      戻り値:
      インデックステンプレートが存在する場合は true
      導入:
      5.1
    • existsIndexTemplate

      boolean existsIndexTemplate(ExistsIndexTemplateRequest existsTemplateRequest)
      インデックステンプレートが存在するかどうかを確認します。
      パラメーター:
      existsTemplateRequest - リクエストパラメーター
      戻り値:
      インデックステンプレートが存在する場合は true
      導入:
      5.1
    • getIndexTemplate

      default ListSE<TemplateResponse> getIndexTemplate(StringSE templateName)
      インデックステンプレートを取得します。
      パラメーター:
      templateName - テンプレート名
      導入:
      5.1
    • getIndexTemplate

      ListSE<TemplateResponse> getIndexTemplate(GetIndexTemplateRequest getIndexTemplateRequest)
      インデックステンプレートを取得します。
      パラメーター:
      getIndexTemplateRequest - リクエストパラメーター
      導入:
      5.1
    • deleteIndexTemplate

      default boolean deleteIndexTemplate(StringSE templateName)
      インデックステンプレートを削除します。
      パラメーター:
      templateName - テンプレート名
      戻り値:
      成功した場合は true
      導入:
      5.1
    • deleteIndexTemplate

      boolean deleteIndexTemplate(DeleteIndexTemplateRequest deleteIndexTemplateRequest)
      インデックステンプレートを削除します。
      パラメーター:
      deleteIndexTemplateRequest - テンプレートリクエストパラメーター
      戻り値:
      成功した場合は true
      導入:
      5.1
    • deleteTemplate

      @DeprecatedSE default boolean deleteTemplate(StringSE templateName)
      使用すべきではありません。
      5.1 以降、基盤となる Elasticsearch API は非推奨になりました。
      従来の Elasticsearch インターフェース (@see、https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)) を使用してインデックステンプレートを削除します。
      パラメーター:
      templateName - テンプレート名
      戻り値:
      成功した場合は true
      導入:
      4.1
    • deleteTemplate

      @DeprecatedSE boolean deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
      使用すべきではありません。
      5.1 以降、基盤となる Elasticsearch API は非推奨になりました。
      従来の Elasticsearch インターフェース (@see、https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)) を使用してインデックステンプレートを削除します。
      パラメーター:
      deleteTemplateRequest - テンプレートリクエストパラメーター
      戻り値:
      成功した場合は true
      導入:
      4.1
    • getInformation

      default ListSE<IndexInformation> getInformation()
      getIndexCoordinates() で定義されたインデックスの IndexInformation を取得します。
      戻り値:
      IndexInformation のリスト
      導入:
      4.2
    • getInformation

      ListSE<IndexInformation> getInformation(IndexCoordinates index)
      #index で定義されたインデックスの IndexInformation を取得します。
      パラメーター:
      index - 情報を取得するためのインデックス名を定義します
      戻り値:
      IndexInformation のリスト
      導入:
      4.2
    • getIndexCoordinates

      IndexCoordinates getIndexCoordinates()
      現在の IndexCoordinates を取得します。エンティティクラスに SpEL で構築されたインデックス名がある場合、これらは時間の経過とともに変更される可能性があります。この IndexOperations がクラスにバインドされていない場合は、バインドされた IndexCoordinates が返されます。
      戻り値:
      IndexCoordinates
      導入:
      4.1