com.arakelian.elastic

Interface OkHttpElasticApi

public interface OkHttpElasticApi

Field Summary

Fields

Modifier and Type	Field and Description
static okhttp3.MediaType	JSON JSON media type

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<About>	about()
retrofit2.Call<BulkResponse>	bulk(java.lang.String operations, java.lang.Boolean pretty)
retrofit2.Call<ClusterHealth>	clusterHealth()
retrofit2.Call<ClusterHealth>	clusterHealth(ClusterHealth.Status waitForStatus, java.lang.String timeout)
retrofit2.Call<ClusterHealth>	clusterHealthForIndex(java.lang.String names, ClusterHealth.Status waitForStatus, java.lang.String timeout)
retrofit2.Call<IndexCreated>	createIndex(java.lang.String name, Index index) Create an index in Elastic.
retrofit2.Call<IndexDeleted>	deleteAllIndexes() Delete all indexes from Elastic.
retrofit2.Call<DeletedDocument>	deleteDocument(java.lang.String name, java.lang.String type, java.lang.String id)
retrofit2.Call<DeletedDocument>	deleteDocument(java.lang.String name, java.lang.String type, java.lang.String id, long epochMillisUtc)
retrofit2.Call<IndexDeleted>	deleteIndex(java.lang.String names) Deletes a comma separated list of index names from Elastic.
retrofit2.Call<Document>	getDocument(java.lang.String name, java.lang.String type, java.lang.String id, java.lang.String sourceFields)
retrofit2.Call<Documents>	getDocuments(Mget mget)
retrofit2.Call<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.
retrofit2.Call<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).
retrofit2.Call<java.lang.Void>	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).
retrofit2.Call<Nodes>	nodes()
retrofit2.Call<Refresh>	refreshAllIndexes()
retrofit2.Call<Refresh>	refreshIndex(java.lang.String names)
retrofit2.Call<SearchResponse>	search(java.lang.String name, java.lang.String preference, java.lang.String scroll, SearchType searchType, java.lang.Boolean requestCache, java.lang.String query)

Field Detail

JSON

static final okhttp3.MediaType JSON

JSON media type

Method Detail

about

@GET(value="/")
retrofit2.Call<About> about()

bulk

@POST(value="/_bulk")
 @Headers(value="Content-Type: application/x-ndjson")
retrofit2.Call<BulkResponse> bulk(@Body
                                                                                                              java.lang.String operations,
                                                                                                              @Query(value="pretty")
                                                                                                              java.lang.Boolean pretty)

clusterHealth

@GET(value="/_cluster/health")
retrofit2.Call<ClusterHealth> clusterHealth()

clusterHealth

@GET(value="/_cluster/health")
retrofit2.Call<ClusterHealth> clusterHealth(@Query(value="wait_for_status")
                                                                           ClusterHealth.Status waitForStatus,
                                                                           @Query(value="timeout")
                                                                           java.lang.String timeout)

clusterHealthForIndex

@GET(value="/_cluster/health/{names}")
retrofit2.Call<ClusterHealth> clusterHealthForIndex(@Path(value="names")
                                                                                           java.lang.String names,
                                                                                           @Query(value="wait_for_status")
                                                                                           ClusterHealth.Status waitForStatus,
                                                                                           @Query(value="timeout")
                                                                                           java.lang.String timeout)

createIndex

@PUT(value="/{name}")
retrofit2.Call<IndexCreated> createIndex(@Path(value="name")
                                                               java.lang.String name,
                                                               @Body
                                                               Index index)

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

deleteAllIndexes

@DELETE(value="/*")
retrofit2.Call<IndexDeleted> deleteAllIndexes()

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

deleteDocument

@DELETE(value="/{name}/{type}/{id}")
retrofit2.Call<DeletedDocument> deleteDocument(@Path(value="name")
                                                                                    java.lang.String name,
                                                                                    @Path(value="type")
                                                                                    java.lang.String type,
                                                                                    @Path(value="id")
                                                                                    java.lang.String id)

deleteDocument

@DELETE(value="/{name}/{type}/{id}?version_type=external")
retrofit2.Call<DeletedDocument> deleteDocument(@Path(value="name")
                                                                                                          java.lang.String name,
                                                                                                          @Path(value="type")
                                                                                                          java.lang.String type,
                                                                                                          @Path(value="id")
                                                                                                          java.lang.String id,
                                                                                                          @Query(value="version")
                                                                                                          long epochMillisUtc)

deleteIndex

@DELETE(value="/{names}")
retrofit2.Call<IndexDeleted> deleteIndex(@Path(value="names")
                                                                   java.lang.String names)

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

getDocument

@GET(value="/{name}/{type}/{id}")
retrofit2.Call<Document> getDocument(@Path(value="name")
                                                                       java.lang.String name,
                                                                       @Path(value="type")
                                                                       java.lang.String type,
                                                                       @Path(value="id")
                                                                       java.lang.String id,
                                                                       @Query(value="_source")
                                                                       java.lang.String sourceFields)

getDocuments

@POST(value="/_mget")
retrofit2.Call<Documents> getDocuments(@Body
                                                             Mget mget)

indexDocument

@PUT(value="/{name}/{type}/{id}")
 @Headers(value="Content-Type: application/json; charset=UTF-8")
retrofit2.Call<IndexedDocument> indexDocument(@Path(value="name")
                                                                                                                                                 java.lang.String name,
                                                                                                                                                 @Path(value="type")
                                                                                                                                                 java.lang.String type,
                                                                                                                                                 @Path(value="id")
                                                                                                                                                 java.lang.String id,
                                                                                                                                                 @Body
                                                                                                                                                 java.lang.String document)

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

See Also:

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

indexDocument

@PUT(value="/{name}/{type}/{id}?version_type=external")
 @Headers(value="Content-Type: application/json; charset=UTF-8")
retrofit2.Call<IndexedDocument> indexDocument(@Path(value="name")
                                                                                                                                                                       java.lang.String name,
                                                                                                                                                                       @Path(value="type")
                                                                                                                                                                       java.lang.String type,
                                                                                                                                                                       @Path(value="id")
                                                                                                                                                                       java.lang.String id,
                                                                                                                                                                       @Body
                                                                                                                                                                       java.lang.String document,
                                                                                                                                                                       @Query(value="version")
                                                                                                                                                                       long epochMillisUtc)

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

See Also:

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

indexExists

@HEAD(value="/{name}")
retrofit2.Call<java.lang.Void> indexExists(@Path(value="name")
                                                                  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).

Parameters:

name - index name

Returns:

HTTP 200 if index exists

nodes

@GET(value="/_nodes/http")
retrofit2.Call<Nodes> nodes()

refreshAllIndexes

@POST(value="/_refresh")
retrofit2.Call<Refresh> refreshAllIndexes()

refreshIndex

@POST(value="/{names}/_refresh")
retrofit2.Call<Refresh> refreshIndex(@Path(value="names")
                                                                      java.lang.String names)

search

@POST(value="/{name}/_search")
 @Headers(value="Content-Type: application/json; charset=UTF-8")
retrofit2.Call<SearchResponse> search(@Path(value="name")
                                                                                                                                      java.lang.String name,
                                                                                                                                      @Query(value="preference")
                                                                                                                                      java.lang.String preference,
                                                                                                                                      @Query(value="scroll")
                                                                                                                                      java.lang.String scroll,
                                                                                                                                      @Query(value="search_type")
                                                                                                                                      SearchType searchType,
                                                                                                                                      @Query(value="request_cache")
                                                                                                                                      java.lang.Boolean requestCache,
                                                                                                                                      @Body
                                                                                                                                      java.lang.String query)