ElasticSearchAdmin (Nuxeo ECM Projects 8.10-SNAPSHOT API)

All Known Implementing Classes:

ElasticSearchAdminImpl, ElasticSearchComponent
```
public interface ElasticSearchAdmin
```
Administration interface for Elasticsearch service

Since:

5.9.3

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`dropAndInitIndex(String indexName)` Reinitialize an index.
`void`	`dropAndInitRepositoryIndex(String repositoryName)` Reinitialize the index of a repository.
`void`	`flush()` Elasticsearch flush on all document indexes, triggers a lucene commit, empties the transaction log.
`void`	`flushRepositoryIndex(String repositoryName)` Elasticsearch flush on document index for a specific repository, triggers a lucene commit, empties the transaction log.
`org.elasticsearch.client.Client`	`getClient()` Retrieves the `Client` that can be used to access Elasticsearch API
`String`	`getIndexNameForRepository(String repositoryName)` Get the index name associated with the repository name.
`String`	`getIndexNameForType(String type)` Get the first index name with the given type.
`List<String>`	`getIndexNamesForType(String type)` Get the index names with the given type.
`long`	`getPendingWorkerCount()` Returns the number of indexing worker scheduled waiting to be executed.
`List<String>`	`getRepositoryNames()` List repository names that have Elasticsearch support.
`long`	`getRunningWorkerCount()` Returns the number of indexing worker that are currently running.
`int`	`getTotalCommandProcessed()` Returns the total number of command processed by Elasticsearch for this Nuxeo instance.
`void`	`initIndexes(boolean dropIfExists)` Initialize Elasticsearch indexes.
`boolean`	`isEmbedded()` Returns true if the Elasticsearch is embedded with Nuxeo, sharing the same JVM.
`boolean`	`isIndexingInProgress()` Returns true if there are indexing activities scheduled or running.
`void`	`optimize()` Elasticsearch run `optimizeRepositoryIndex(java.lang.String)` on all document indexes,
`void`	`optimizeIndex(String indexName)` Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.
`void`	`optimizeRepositoryIndex(String repositoryName)` Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.
`com.google.common.util.concurrent.ListenableFuture<Boolean>`	`prepareWaitForIndexing()` A `Future` that accepts callback on completion when all the indexing worker are done.
`void`	`refresh()` Refresh all document indexes, immediately after the operation occurs, so that the updated document appears in search results immediately.
`void`	`refreshRepositoryIndex(String repositoryName)` Refresh document index for the specific repository, immediately after the operation occurs, so that the updated document appears in search results immediately.
`boolean`	`useExternalVersion()` When true use an external version for Elasticsearch document, this enable an optimistic concurrency control ensuring that an older version of a document never overwrites a newer version.

- Method Detail
  - getClient
```
org.elasticsearch.client.Client getClient()
```
    Retrieves the Client that can be used to access Elasticsearch API
    
    Since:
    
    5.9.3
  - initIndexes
```
void initIndexes(boolean dropIfExists)
```
    Initialize Elasticsearch indexes. Setup the index settings and mapping for each index that has been registered.
    
    Parameters:
    
    dropIfExists - if {true} remove an existing index
    
    Since:
    
    5.9.3
  - dropAndInitIndex
```
void dropAndInitIndex(String indexName)
```
    Reinitialize an index. This will drop the existing index, recreate it with its settings and mapping, the index will be empty.
    
    Since:
    
    7.3
  - dropAndInitRepositoryIndex
```
void dropAndInitRepositoryIndex(String repositoryName)
```
    Reinitialize the index of a repository. This will drop the existing index, recreate it with its settings and mapping, the index will be empty.
    
    Since:
    
    7.1
  - getRepositoryNames
```
List<String> getRepositoryNames()
```
    List repository names that have Elasticsearch support.
    
    Since:
    
    7.1
  - getIndexNameForRepository
```
String getIndexNameForRepository(String repositoryName)
```
    Get the index name associated with the repository name.
    
    Throws:
    
    NoSuchElementException - if there is no Elasticsearch index associated with the requested repository.
    
    Since:
    
    7.2
  - getIndexNamesForType
```
List<String> getIndexNamesForType(String type)
```
    Get the index names with the given type.
    
    Since:
    
    7.10
  - getIndexNameForType
```
String getIndexNameForType(String type)
```
    Get the first index name with the given type.
    
    Throws:
    
    NoSuchElementException - if there is no Elasticsearch index with the given type.
    
    Since:
    
    7.10
  - isIndexingInProgress
```
boolean isIndexingInProgress()
```
    Returns true if there are indexing activities scheduled or running.
    
    Since:
    
    5.9.5
  - prepareWaitForIndexing
```
com.google.common.util.concurrent.ListenableFuture<Boolean> prepareWaitForIndexing()
```
    A Future that accepts callback on completion when all the indexing worker are done.
    
    Since:
    
    7.2
  - refresh
```
void refresh()
```
    Refresh all document indexes, immediately after the operation occurs, so that the updated document appears in search results immediately. There is no fsync thus doesn't guarantee durability.
    
    Since:
    
    5.9.3
  - refreshRepositoryIndex
```
void refreshRepositoryIndex(String repositoryName)
```
    Refresh document index for the specific repository, immediately after the operation occurs, so that the updated document appears in search results immediately. There is no fsync thus doesn't guarantee durability.
    
    Since:
    
    5.9.4
  - flush
```
void flush()
```
    Elasticsearch flush on all document indexes, triggers a lucene commit, empties the transaction log. Data is flushed to disk.
    
    Since:
    
    5.9.3
  - flushRepositoryIndex
```
void flushRepositoryIndex(String repositoryName)
```
    Elasticsearch flush on document index for a specific repository, triggers a lucene commit, empties the transaction log. Data is flushed to disk.
    
    Since:
    
    5.9.4
  - optimize
```
void optimize()
```
    Elasticsearch run optimizeRepositoryIndex(java.lang.String) on all document indexes,
    
    Since:
    
    7.2
  - optimizeRepositoryIndex
```
void optimizeRepositoryIndex(String repositoryName)
```
    Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.
    
    Since:
    
    7.2
  - optimizeIndex
```
void optimizeIndex(String indexName)
```
    Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.
    
    Since:
    
    7.3
  - getPendingWorkerCount
```
long getPendingWorkerCount()
```
    Returns the number of indexing worker scheduled waiting to be executed.
    
    Since:
    
    7.1
  - getRunningWorkerCount
```
long getRunningWorkerCount()
```
    Returns the number of indexing worker that are currently running.
    
    Since:
    
    7.1
  - getTotalCommandProcessed
```
int getTotalCommandProcessed()
```
    Returns the total number of command processed by Elasticsearch for this Nuxeo instance. Useful for test assertion.
    
    Since:
    
    5.9.4
  - isEmbedded
```
boolean isEmbedded()
```
    Returns true if the Elasticsearch is embedded with Nuxeo, sharing the same JVM.
    
    Since:
    
    7.2
  - useExternalVersion
```
boolean useExternalVersion()
```
    When true use an external version for Elasticsearch document, this enable an optimistic concurrency control ensuring that an older version of a document never overwrites a newer version.
    
    Since:
    
    8.3

Interface ElasticSearchAdmin

Method Summary

Method Detail

getClient

initIndexes

dropAndInitIndex

dropAndInitRepositoryIndex

getRepositoryNames

getIndexNameForRepository

getIndexNamesForType

getIndexNameForType

isIndexingInProgress

prepareWaitForIndexing

refresh

refreshRepositoryIndex

flush

flushRepositoryIndex

optimize

optimizeRepositoryIndex

optimizeIndex

getPendingWorkerCount

getRunningWorkerCount

getTotalCommandProcessed

isEmbedded

useExternalVersion