com.arakelian.elastic

Class OkHttpElasticClient

java.lang.Object

com.arakelian.elastic.OkHttpElasticClient

All Implemented Interfaces:

ElasticClient

public class OkHttpElasticClient
extends java.lang.Object
implements ElasticClient

Field Summary

Fields

Modifier and Type	Field and Description
protected OkHttpElasticApiFactory	elasticApiFactory
protected java.lang.String	elasticUrl
protected com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor and Description
OkHttpElasticClient(java.lang.String elasticUrl, OkHttpElasticApiFactory elasticApiFactory, com.fasterxml.jackson.databind.ObjectMapper mapper)
OkHttpElasticClient(java.lang.String elasticUrl, OkHttpElasticApiFactory elasticApiFactory, com.fasterxml.jackson.databind.ObjectMapper mapper, VersionComponents version)

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.
protected <T> T	execute(java.util.concurrent.Callable<com.arakelian.elastic.OkHttpElasticClient.DelegatingCall<T>> request)
protected OkHttpElasticApi	getApi()
Document	getDocument(java.lang.String name, java.lang.String type, java.lang.String id, java.lang.String sourceFields)
Documents	getDocuments(Mget mget)
VersionComponents	getVersion()
protected OkHttpElasticApi	getVersionedApi()
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).
protected java.lang.String	nextElasticUrl()
Nodes	nodes()
Refresh	refreshAllIndexes()
Refresh	refreshIndex(java.lang.String names)
SearchResponse	search(java.lang.String name, Search search)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

elasticApiFactory

protected final OkHttpElasticApiFactory elasticApiFactory

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

elasticUrl

protected final java.lang.String elasticUrl

Constructor Detail

OkHttpElasticClient

public OkHttpElasticClient(java.lang.String elasticUrl,
                           OkHttpElasticApiFactory elasticApiFactory,
                           com.fasterxml.jackson.databind.ObjectMapper mapper)

OkHttpElasticClient

public OkHttpElasticClient(java.lang.String elasticUrl,
                           OkHttpElasticApiFactory elasticApiFactory,
                           com.fasterxml.jackson.databind.ObjectMapper mapper,
                           VersionComponents version)

Method Detail

about

public About about()
            throws ElasticException

Specified by:

about in interface ElasticClient

Throws:

ElasticException

bulk

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

Specified by:

bulk in interface ElasticClient

Throws:

ElasticException

clusterHealth

public ClusterHealth clusterHealth()
                            throws ElasticException

Specified by:

clusterHealth in interface ElasticClient

Throws:

ElasticException

clusterHealth

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

Specified by:

clusterHealth in interface ElasticClient

Throws:

ElasticException

clusterHealthForIndex

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

Specified by:

clusterHealthForIndex in interface ElasticClient

Throws:

ElasticException

createIndex

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

Description copied from interface: ElasticClient

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.

Specified by:

createIndex in interface ElasticClient

Parameters:

name - index name

index - index configuration

Returns:

an OkHttp3 call

Throws:

ElasticException - if there an exception making HTTP request

deleteAllIndexes

public IndexDeleted deleteAllIndexes()
                              throws ElasticException

Description copied from interface: ElasticClient

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.

Specified by:

deleteAllIndexes in interface ElasticClient

Returns:

response from Elastic acknowledging the request

Throws:

ElasticException - if there an exception making HTTP request

deleteDocument

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

Specified by:

deleteDocument in interface ElasticClient

Throws:

ElasticException

deleteDocument

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

Specified by:

deleteDocument in interface ElasticClient

Throws:

ElasticException

deleteIndex

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

Description copied from interface: ElasticClient

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.

Specified by:

deleteIndex in interface ElasticClient

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

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

Specified by:

getDocument in interface ElasticClient

Throws:

ElasticException

getDocuments

public Documents getDocuments(Mget mget)
                       throws ElasticException

Specified by:

getDocuments in interface ElasticClient

Throws:

ElasticException

getVersion

public VersionComponents getVersion()

Specified by:

getVersion in interface ElasticClient

indexDocument

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

Description copied from interface: ElasticClient

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

Specified by:

indexDocument in interface ElasticClient

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

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

Description copied from interface: ElasticClient

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.

Specified by:

indexDocument in interface ElasticClient

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

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

Description copied from interface: ElasticClient

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).

Specified by:

indexExists in interface ElasticClient

Parameters:

name - index name

Returns:

HTTP 200 if index exists

Throws:

ElasticException - if there an exception making HTTP request

nodes

public Nodes nodes()
            throws ElasticException

Specified by:

nodes in interface ElasticClient

Throws:

ElasticException

refreshAllIndexes

public Refresh refreshAllIndexes()
                          throws ElasticException

Specified by:

refreshAllIndexes in interface ElasticClient

Throws:

ElasticException

refreshIndex

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

Specified by:

refreshIndex in interface ElasticClient

Throws:

ElasticException

search

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

Specified by:

search in interface ElasticClient

execute

protected <T> T execute(java.util.concurrent.Callable<com.arakelian.elastic.OkHttpElasticClient.DelegatingCall<T>> request)
                 throws ElasticException

Throws:

ElasticException

getApi

protected OkHttpElasticApi getApi()

getVersionedApi

protected OkHttpElasticApi getVersionedApi()

nextElasticUrl

protected java.lang.String nextElasticUrl()