ElasticsearchObject (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>
- - org.nuxeo.ecm.restapi.server.jaxrs.management.ElasticsearchObject

All Implemented Interfaces:

Resource, Adaptable
```
public class ElasticsearchObject
extends AbstractResource<ResourceTypeImpl>
```
Endpoint to manage Elasticsearch.

Since:

11.3

Field Summary

Fields
Modifier and Type Field Description

static String GET_ALL_DOCUMENTS_QUERY
- Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
  ctx, next, path, prev, type

Constructor Summary

Constructors
Constructor Description

ElasticsearchObject()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doFlush()`	Executes an ES flush on document index of a given repository.
`BulkStatus`	`doIndexing(String query)`	Performs an ES indexing on documents matching the optional NXQL query.
`BulkStatus`	`doIndexingOnDocument(String documentId)`	Performs an ES indexing on the given document and his children.
`void`	`doOptimize()`	Executes an ES optimize on document index of a given repository.
`protected BulkStatus`	`performIndexing(String query)`	Performs an ES indexing on documents matching the optional NXQL query.

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - GET_ALL_DOCUMENTS_QUERY
```
public static final String GET_ALL_DOCUMENTS_QUERY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ElasticsearchObject
```
public ElasticsearchObject()
```
- Method Detail
  - doIndexing
```
public BulkStatus doIndexing(String query)
```
    Performs an ES indexing on documents matching the optional NXQL query.
    
    See Also:
    
    performIndexing(String)
  - doIndexingOnDocument
```
public BulkStatus doIndexingOnDocument(String documentId)
```
    Performs an ES indexing on the given document and his children.
    
    Parameters:
    
    documentId - the id of the document that will be indexed and his children recursively
    
    See Also:
    
    performIndexing(String)
  - doFlush
```
public void doFlush()
```
    Executes an ES flush on document index of a given repository.
  - doOptimize
```
public void doOptimize()
```
    Executes an ES optimize on document index of a given repository.
  - performIndexing
```
protected BulkStatus performIndexing(String query)
```
    Performs an ES indexing on documents matching the optional NXQL query.
    
    Parameters:
    
    query - the NXQL query that documents must match to be indexed, can be null or empty, in this case all documents of the given repository will be indexed GET_ALL_DOCUMENTS_QUERY
    
    Returns:
    
    the BulkStatus of the ES indexing