インターフェース IndexOperations
- すべての既知のサブインターフェース:
IndexOperationsAdapter
- すべての既知の実装クラス:
IndicesTemplate
public interface IndexOperations
Elasticsearch インデックス API の操作。
IndexOperations は、
IndexOperations は、
ElasticsearchOperations.indexOps(IndexCoordinates)
または ElasticsearchOperations.indexOps(Class)
によってエンティティクラスまたは IndexCoordinate にバインドされます。- 導入:
- 4.0
- 作成者:
- Peter-Josef Meisch, Sascha Woo, George Popides
メソッドのサマリー
修飾子と型メソッド説明boolean
alias
(AliasActions aliasActions) 指定されたAliasActions
を実行します。boolean
create()
インデックスを作成します。boolean
指定された設定のインデックスを作成します。boolean
指定された設定とマッピングのインデックスを作成します。この IndexOperations がバインドされているエンティティのインデックスマッピングを作成します。createMapping
(ClassSE<?> clazz) 指定されたクラスのインデックスマッピングを作成しますこの IndexOperations がバインドされているエンティティのインデックス設定を作成します。createSettings
(ClassSE<?> clazz) 指定されたクラスのアノテーションからインデックス設定を作成しますboolean
この IndexOperations がバインドされているエンティティに対して定義された設定とマッピングを使用してインデックスを作成します。boolean
delete()
このIndexOperations
がバインドされているインデックスを削除しますboolean
deleteComponentTemplate
(DeleteComponentTemplateRequest deleteComponentTemplateRequest) 指定されたコンポーネントインデックステンプレートを削除しますdefault boolean
deleteIndexTemplate
(StringSE templateName) インデックステンプレートを削除します。boolean
deleteIndexTemplate
(DeleteIndexTemplateRequest deleteIndexTemplateRequest) インデックステンプレートを削除します。default boolean
deleteTemplate
(StringSE templateName) 使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。boolean
deleteTemplate
(DeleteTemplateRequest deleteTemplateRequest) 使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。boolean
exists()
この IndexOperations がバインドされているインデックスが存在するかどうかを確認しますboolean
existsComponentTemplate
(ExistsComponentTemplateRequest existsComponentTemplateRequest) コンポーネントインデックステンプレートが存在するかどうかを確認します。default boolean
existsIndexTemplate
(StringSE templateName) インデックステンプレートが存在するかどうかを確認します。boolean
existsIndexTemplate
(ExistsIndexTemplateRequest existsTemplateRequest) インデックステンプレートが存在するかどうかを確認します。default boolean
existsTemplate
(StringSE templateName) 使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。boolean
existsTemplate
(ExistsTemplateRequest existsTemplateRequest) 使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。getAliases
(StringSE... aliasNames) エイリアスに関する情報を取得しますgetAliasesForIndex
(StringSE... indexNames) エイリアスに関する情報を取得しますgetComponentTemplate
(GetComponentTemplateRequest getComponentTemplateRequest) コンポーネントテンプレートを取得します。現在のIndexCoordinates
を取得します。default ListSE<TemplateResponse>
getIndexTemplate
(StringSE templateName) インデックステンプレートを取得します。getIndexTemplate
(GetIndexTemplateRequest getIndexTemplateRequest) インデックステンプレートを取得します。default ListSE<IndexInformation>
getIndexCoordinates()
で定義されたインデックスのIndexInformation
を取得します。getInformation
(IndexCoordinates index) #index で定義されたインデックスのIndexInformation
を取得します。クラスによって定義されたインデックスのマッピングを取得します。インデックス設定を取得します。getSettings
(boolean includeDefaults) インデックス設定を取得します。default TemplateData
getTemplate
(StringSE templateName) 使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。getTemplate
(GetTemplateRequest getTemplateRequest) 使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。boolean
putComponentTemplate
(PutComponentTemplateRequest putComponentTemplateRequest) 構成可能なインデックステンプレートで使用できるコンポーネントインデックステンプレートを書き込みます。boolean
putIndexTemplate
(PutIndexTemplateRequest putIndexTemplateRequest) インデックステンプレートを作成するdefault boolean
この IndexOperations がバインドされているクラスのインデックスへのマッピングを書き込みます。default boolean
putMapping
(ClassSE<?> clazz) 指定されたクラスのインデックスマッピングを作成し、それをインデックスに書き込みます。boolean
putMapping
(Document mapping) インデックスへのマッピングを書き込むboolean
putTemplate
(PutTemplateRequest putTemplateRequest) 使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。void
refresh()
この IndexOperations がバインドされているインデックスをリフレッシュします
メソッドの詳細
create
boolean create()インデックスを作成します。- 戻り値:
- インデックスが作成された場合は true
create
指定された設定のインデックスを作成します。- パラメーター:
settings
- インデックス設定- 戻り値:
- インデックスが作成された場合は true
create
指定された設定とマッピングのインデックスを作成します。- パラメーター:
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
指定されたクラスのインデックスマッピングを作成します- パラメーター:
clazz
- マッピングを作成するための clazz- 戻り値:
- マッピングオブジェクト
putMapping
default boolean putMapping()この IndexOperations がバインドされているクラスのインデックスへのマッピングを書き込みます。- 戻り値:
- マッピングを保存できる場合は true
- 導入:
- 4.1
putMapping
インデックスへのマッピングを書き込む- パラメーター:
mapping
- マッピング定義を含むドキュメント- 戻り値:
- マッピングを保存できる場合は true
putMapping
指定されたクラスのインデックスマッピングを作成し、それをインデックスに書き込みます。- パラメーター:
clazz
- マッピングを作成するための clazz- 戻り値:
- マッピングを保存できる場合は true
- 導入:
- 4.1
getMapping
クラスによって定義されたインデックスのマッピングを取得します。- 戻り値:
- マッピング
createSettings
Settings createSettings()この IndexOperations がバインドされているエンティティのインデックス設定を作成します。- 戻り値:
- 設定ドキュメント。
- 導入:
- 4.1
createSettings
指定されたクラスのアノテーションからインデックス設定を作成します- パラメーター:
clazz
- インデックス設定を作成するクラス- 戻り値:
- 設定ドキュメント。
- 導入:
- 4.1
getSettings
Settings getSettings()インデックス設定を取得します。- 戻り値:
- 設定
getSettings
インデックス設定を取得します。- パラメーター:
includeDefaults
- すべてのデフォルト設定を含めるかどうか- 戻り値:
- 設定
alias
指定されたAliasActions
を実行します。- パラメーター:
aliasActions
- 実行するアクション- 戻り値:
- 操作が Elasticsearch によって確認された場合
- 導入:
- 4.1
getAliases
エイリアスに関する情報を取得しますgetAliasesForIndex
エイリアスに関する情報を取得しますputTemplate
使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。従来の Elasticsearch インターフェース (@see、https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)) を使用してインデックステンプレートを作成します。- パラメーター:
putTemplateRequest
- テンプレートリクエストパラメーター- 戻り値:
- 成功した場合は true
- 導入:
- 4.1
putIndexTemplate
インデックステンプレートを作成する- パラメーター:
putIndexTemplateRequest
- テンプレートリクエストパラメーター- 戻り値:
- 成功した場合は true
- 導入:
- 5.1
putComponentTemplate
構成可能なインデックステンプレートで使用できるコンポーネントインデックステンプレートを書き込みます。- パラメーター:
putComponentTemplateRequest
- インデックステンプレートのリクエストパラメーター- 戻り値:
- 成功した場合は true
- 導入:
- 5.1
existsComponentTemplate
コンポーネントインデックステンプレートが存在するかどうかを確認します。- パラメーター:
existsComponentTemplateRequest
- リクエストのパラメーター- 戻り値:
- componentTemplate が存在する場合は true です。
- 導入:
- 5.1
getComponentTemplate
ListSE<TemplateResponse> getComponentTemplate(GetComponentTemplateRequest getComponentTemplateRequest) コンポーネントテンプレートを取得します。- パラメーター:
getComponentTemplateRequest
- リクエストのパラメーター。ワイルドカード名を含めることができます- 戻り値:
- 見つかった
TemplateResponse
は空である可能性があります - 導入:
- 5.1
deleteComponentTemplate
指定されたコンポーネントインデックステンプレートを削除します- パラメーター:
deleteComponentTemplateRequest
- リクエストパラメーター- 戻り値:
- 成功した場合は true。
- 導入:
- 5.1
getTemplate
使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。従来の Elasticsearch インターフェースを使用してインデックステンプレートを取得します。- パラメーター:
templateName
- テンプレート名- 戻り値:
- TemplateData、指定された名前のテンプレートが存在しない場合は null。
- 導入:
- 4.1
getTemplate
使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。従来の Elasticsearch インターフェースを使用してインデックステンプレートを取得します。- パラメーター:
getTemplateRequest
- リクエストパラメーター- 戻り値:
- TemplateData、指定された名前のテンプレートが存在しない場合は null。
- 導入:
- 4.1
existsTemplate
使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。従来の Elasticsearch インターフェースを使用してインデックステンプレートが存在するかどうかを確認します。- パラメーター:
templateName
- テンプレート名- 戻り値:
- インデックスが存在する場合は true
- 導入:
- 4.1
existsTemplate
使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。従来の Elasticsearch インターフェースを使用してインデックステンプレートが存在するかどうかを確認します。- パラメーター:
existsTemplateRequest
- リクエストパラメーター- 戻り値:
- インデックスが存在する場合は true
- 導入:
- 4.1
existsIndexTemplate
インデックステンプレートが存在するかどうかを確認します。- パラメーター:
templateName
- テンプレート名- 戻り値:
- インデックステンプレートが存在する場合は true
- 導入:
- 5.1
existsIndexTemplate
インデックステンプレートが存在するかどうかを確認します。- パラメーター:
existsTemplateRequest
- リクエストパラメーター- 戻り値:
- インデックステンプレートが存在する場合は true
- 導入:
- 5.1
getIndexTemplate
インデックステンプレートを取得します。- パラメーター:
templateName
- テンプレート名- 導入:
- 5.1
getIndexTemplate
インデックステンプレートを取得します。- パラメーター:
getIndexTemplateRequest
- リクエストパラメーター- 導入:
- 5.1
deleteIndexTemplate
インデックステンプレートを削除します。- パラメーター:
templateName
- テンプレート名- 戻り値:
- 成功した場合は true
- 導入:
- 5.1
deleteIndexTemplate
インデックステンプレートを削除します。- パラメーター:
deleteIndexTemplateRequest
- テンプレートリクエストパラメーター- 戻り値:
- 成功した場合は true
- 導入:
- 5.1
deleteTemplate
使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。従来の Elasticsearch インターフェース (@see、https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)) を使用してインデックステンプレートを削除します。- パラメーター:
templateName
- テンプレート名- 戻り値:
- 成功した場合は true
- 導入:
- 4.1
deleteTemplate
使用すべきではありません。5.1 以降、基盤となる Elasticsearch API は非推奨になりました。従来の Elasticsearch インターフェース (@see、https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html)) を使用してインデックステンプレートを削除します。- パラメーター:
deleteTemplateRequest
- テンプレートリクエストパラメーター- 戻り値:
- 成功した場合は true
- 導入:
- 4.1
getInformation
getIndexCoordinates()
で定義されたインデックスのIndexInformation
を取得します。- 戻り値:
IndexInformation
のリスト- 導入:
- 4.2
getInformation
#index で定義されたインデックスのIndexInformation
を取得します。- パラメーター:
index
- 情報を取得するためのインデックス名を定義します- 戻り値:
IndexInformation
のリスト- 導入:
- 4.2
getIndexCoordinates
IndexCoordinates getIndexCoordinates()現在のIndexCoordinates
を取得します。エンティティクラスに SpEL で構築されたインデックス名がある場合、これらは時間の経過とともに変更される可能性があります。この IndexOperations がクラスにバインドされていない場合は、バインドされた IndexCoordinates が返されます。- 戻り値:
- IndexCoordinates
- 導入:
- 4.1