com.arakelian.elastic

Interface ElasticClient

All Known Implementing Classes:

ElasticClientWithRetry, OkHttpElasticClient

public interface ElasticClient

Elastic API

See Also:

Elastic Rest API specification

Method Summary

Modifier and Type	Method and Description
About	about()
BulkResponse	bulk(java.lang.String operations, java.lang.Boolean pretty)
ClusterHealth	clusterHealth()
ClusterHealth	clusterHealth(ClusterHealth.Status waitForStatus, java.lang.String timeout)
ClusterHealth	clusterHealthForIndex(java.lang.String names, ClusterHealth.Status waitForStatus, java.lang.String timeout)
IndexCreated	createIndex(java.lang.String name, Index index) Create an index in Elastic.
IndexDeleted	deleteAllIndexes() Delete all indexes from Elastic.
DeletedDocument	deleteDocument(java.lang.String name, java.lang.String type, java.lang.String id)
DeletedDocument	deleteDocument(java.lang.String name, java.lang.String type, java.lang.String id, long epochMillisUtc)
IndexDeleted	deleteIndex(java.lang.String names) Deletes a comma separated list of index names from Elastic.
Document	getDocument(java.lang.String name, java.lang.String type, java.lang.String id, java.lang.String sourceFields)
Documents	getDocuments(Mget mget)
VersionComponents	getVersion()
IndexedDocument	indexDocument(java.lang.String name, java.lang.String type, java.lang.String id, java.lang.String document) Indexes a document using default versioning scheme, which simply increments the document version number.
IndexedDocument	indexDocument(java.lang.String name, java.lang.String type, java.lang.String id, java.lang.String document, long epochMillisUtc) Indexes a document using an external versioning scheme, based upon milliseconds since epoch (UTC timezone).
boolean	indexExists(java.lang.String name) Checks to see if specified index exists Elastic will return a success code (HTTP 200) if the index exists, otherwise it returns an HTTP 404 (not found).
Nodes	nodes()
Refresh	refreshAllIndexes()
Refresh	refreshIndex(java.lang.String names)
SearchResponse	search(java.lang.String name, Search search)

Method Detail

about

About about()
     throws ElasticException

Throws:

ElasticException

bulk

BulkResponse bulk(java.lang.String operations,
                  java.lang.Boolean pretty)
           throws ElasticException

Throws:

ElasticException

clusterHealth

ClusterHealth clusterHealth()
                     throws ElasticException

Throws:

ElasticException

clusterHealth

ClusterHealth clusterHealth(ClusterHealth.Status waitForStatus,
                            java.lang.String timeout)
                     throws ElasticException

Throws:

ElasticException

clusterHealthForIndex

ClusterHealth clusterHealthForIndex(java.lang.String names,
                                    ClusterHealth.Status waitForStatus,
                                    java.lang.String timeout)
                             throws ElasticException

Throws:

ElasticException

createIndex

IndexCreated createIndex(java.lang.String name,
                         Index index)
                  throws ElasticException

Create an index in Elastic. Elastic will return a response acknowledging the request, however it make take a little time for the index to actually be deleted.

Parameters:

name - index name

index - index configuration

Returns:

an OkHttp3 call

Throws:

ElasticException - if there an exception making HTTP request

deleteAllIndexes

IndexDeleted deleteAllIndexes()
                       throws ElasticException

Delete all indexes from Elastic. Elastic will return a response acknowledging the request, however it make take a little time for the indexes to actually be deleted.

Returns:

response from Elastic acknowledging the request

Throws:

ElasticException - if there an exception making HTTP request

deleteDocument

DeletedDocument deleteDocument(java.lang.String name,
                               java.lang.String type,
                               java.lang.String id)
                        throws ElasticException

Throws:

ElasticException

deleteDocument

DeletedDocument deleteDocument(java.lang.String name,
                               java.lang.String type,
                               java.lang.String id,
                               long epochMillisUtc)
                        throws ElasticException

Throws:

ElasticException

deleteIndex

IndexDeleted deleteIndex(java.lang.String names)
                  throws ElasticException

Deletes a comma separated list of index names from Elastic. Elastic will return a response acknowledging the request, however it make take a little time for the indexes to actually be deleted.

Parameters:

names - comma separated list of index names

Returns:

response from Elastic acknowledging the request

Throws:

ElasticException - if there an exception making HTTP request

getDocument

Document getDocument(java.lang.String name,
                     java.lang.String type,
                     java.lang.String id,
                     java.lang.String sourceFields)
              throws ElasticException

Throws:

ElasticException

getDocuments

Documents getDocuments(Mget mget)
                throws ElasticException

Throws:

ElasticException

getVersion

VersionComponents getVersion()

indexDocument

IndexedDocument indexDocument(java.lang.String name,
                              java.lang.String type,
                              java.lang.String id,
                              java.lang.String document)
                       throws ElasticException

Indexes a document using default versioning scheme, which simply increments the document version number.

Parameters:

name - index name

type - mapping type

id - document id

document - document that is being indexed

Returns:

response from Elastic indicating that document was indexed

Throws:

ElasticException - if there an exception making HTTP request

See Also:

https://www.elastic.co/blog/elasticsearch-versioning-support

indexDocument

IndexedDocument indexDocument(java.lang.String name,
                              java.lang.String type,
                              java.lang.String id,
                              java.lang.String document,
                              long epochMillisUtc)
                       throws ElasticException

Indexes a document using an external versioning scheme, based upon milliseconds since epoch (UTC timezone). With version_type set to external, Elasticsearch will store the version number as given and will not increment it. Also, instead of checking for an exact match, Elasticsearch will only return a version collision error if the version currently stored is greater or equal to the one in the indexing command. IMPORTANT: When using external versioning, make sure you always add the current version to any index, update or delete calls. If you forget, Elasticsearch will use it's internal system to process that request, which will cause the version to be incremented erroneously.

Parameters:

name - index name

type - mapping type

id - document id

document - document that is being indexed

epochMillisUtc - Number of milliseconds since epoch (normalized to UTC time)

Returns:

response from Elastic indicating that document was indexed

Throws:

ElasticException - if there an exception making HTTP request

See Also:

https://www.elastic.co/blog/elasticsearch-versioning-support

indexExists

boolean indexExists(java.lang.String name)
             throws ElasticException

Checks to see if specified index exists Elastic will return a success code (HTTP 200) if the index exists, otherwise it returns an HTTP 404 (not found).

Parameters:

name - index name

Returns:

HTTP 200 if index exists

Throws:

ElasticException - if there an exception making HTTP request

nodes

Nodes nodes()
     throws ElasticException

Throws:

ElasticException

refreshAllIndexes

Refresh refreshAllIndexes()
                   throws ElasticException

Throws:

ElasticException

refreshIndex

Refresh refreshIndex(java.lang.String names)
              throws ElasticException

Throws:

ElasticException

search

SearchResponse search(java.lang.String name,
                      Search search)