# Complete reference of Java API

**URL:** <https://discuss.elastic.co/t/complete-reference-of-java-api/14314>\
**Category:** Elasticsearch\
**Created:** [November 8, 2013, 1:36am UTC](https://discuss.elastic.co/t/complete-reference-of-java-api/14314 "2013-11-08T01:36:55Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![Mohit\_Anchlia](https://avatars.discourse-cdn.com/v4/letter/m/848f3c/32.png) [@Mohit\_Anchlia](https://discuss.elastic.co/u/Mohit_Anchlia)\
**Post date:** [November 8, 2013, 1:36am UTC](https://discuss.elastic.co/t/complete-reference-of-java-api/14314/1 "2013-11-08T01:36:55Z")

</div>

Is there a place I can get a complete reference of Java API. I am looking  
at  
[http://www.elasticsearch.org/guide/en/elasticsearch/client/java-api/current/index\_.html](http://www.elasticsearch.org/guide/en/elasticsearch/client/java-api/current/index_.html)  
but  
it looks like it doesn't provide complete guide. For instance how do I know  
if a document was indexed successfully using IndexResponse object?

--  
You received this message because you are subscribed to the Google Groups "elasticsearch" group.  
To unsubscribe from this group and stop receiving emails from it, send an email to [elasticsearch+unsubscribe@googlegroups.com](mailto:elasticsearch+unsubscribe@googlegroups.com).  
For more options, visit [https://groups.google.com/groups/opt\_out](https://groups.google.com/groups/opt_out).

---

<div class="post-metadata">

**Author:** ![Ivan](https://avatars.discourse-cdn.com/v4/letter/i/df788c/32.png) [@Ivan](https://discuss.elastic.co/u/Ivan)\
**Post date:** [November 8, 2013, 2:28am UTC](https://discuss.elastic.co/t/complete-reference-of-java-api/14314/2 "2013-11-08T02:28:47Z")

</div>

There is no complete reference for the Java API. Better documentation is  
coming from the elasticsearch team, but I am not sure if that includes  
anything about the Java API (I have a feeling it will focus on using the  
REST API).

My method for understanding the Java API is to view both the tests and the  
various REST actions:

[https://github.com/elasticsearch/elasticsearch/tree/master/src/test/java/org/elasticsearch](https://github.com/elasticsearch/elasticsearch/tree/master/src/test/java/org/elasticsearch)  
[https://github.com/elasticsearch/elasticsearch/tree/master/src/main/java/org/elasticsearch/rest/action](https://github.com/elasticsearch/elasticsearch/tree/master/src/main/java/org/elasticsearch/rest/action)

In your case, perhaps IndexActionTests can help:

> <https://github.com/elastic/elasticsearch/blob/917a3c3b9dd26b623144eeffa2462ffced8c4ec5/src/test/java/org/elasticsearch/indexing/IndexActionTests.java>

Cheers,

Ivan

On Thu, Nov 7, 2013 at 5:36 PM, Mohit Anchlia [mohitanchlia@gmail.com](mailto:mohitanchlia@gmail.com)wrote:

> Is there a place I can get a complete reference of Java API. I am looking  
> at  
> [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/en/elasticsearch/client/java-api/current/index_.html) but  
> it looks like it doesn't provide complete guide. For instance how do I know  
> if a document was indexed successfully using IndexResponse object?
> 
> --  
> You received this message because you are subscribed to the Google Groups  
> "elasticsearch" group.  
> To unsubscribe from this group and stop receiving emails from it, send an  
> email to [elasticsearch+unsubscribe@googlegroups.com](mailto:elasticsearch+unsubscribe@googlegroups.com).  
> For more options, visit [https://groups.google.com/groups/opt\_out](https://groups.google.com/groups/opt_out).

--  
You received this message because you are subscribed to the Google Groups "elasticsearch" group.  
To unsubscribe from this group and stop receiving emails from it, send an email to [elasticsearch+unsubscribe@googlegroups.com](mailto:elasticsearch+unsubscribe@googlegroups.com).  
For more options, visit [https://groups.google.com/groups/opt\_out](https://groups.google.com/groups/opt_out).

---

<div class="post-metadata">

**Author:** ![Mohit\_Anchlia](https://avatars.discourse-cdn.com/v4/letter/m/848f3c/32.png) [@Mohit\_Anchlia](https://discuss.elastic.co/u/Mohit_Anchlia)\
**Post date:** [November 8, 2013, 4:55am UTC](https://discuss.elastic.co/t/complete-reference-of-java-api/14314/3 "2013-11-08T04:55:54Z")

</div>

Thanks!

On Thu, Nov 7, 2013 at 6:28 PM, Ivan Brusic [ivan@brusic.com](mailto:ivan@brusic.com) wrote:

> There is no complete reference for the Java API. Better documentation is  
> coming from the elasticsearch team, but I am not sure if that includes  
> anything about the Java API (I have a feeling it will focus on using the  
> REST API).
> 
> My method for understanding the Java API is to view both the tests and the  
> various REST actions:
> 
> [https://github.com/elasticsearch/elasticsearch/tree/master/src/test/java/org/elasticsearch](https://github.com/elasticsearch/elasticsearch/tree/master/src/test/java/org/elasticsearch)
> 
> [https://github.com/elasticsearch/elasticsearch/tree/master/src/main/java/org/elasticsearch/rest/action](https://github.com/elasticsearch/elasticsearch/tree/master/src/main/java/org/elasticsearch/rest/action)
> 
> In your case, perhaps IndexActionTests can help:
> 
> [https://github.com/elasticsearch/elasticsearch/blob/917a3c3b9dd26b623144eeffa2462ffced8c4ec5/src/test/java/org/elasticsearch/indexing/IndexActionTests.java](https://github.com/elasticsearch/elasticsearch/blob/917a3c3b9dd26b623144eeffa2462ffced8c4ec5/src/test/java/org/elasticsearch/indexing/IndexActionTests.java)
> 
> Cheers,
> 
> Ivan
> 
> On Thu, Nov 7, 2013 at 5:36 PM, Mohit Anchlia [mohitanchlia@gmail.com](mailto:mohitanchlia@gmail.com)wrote:
> 
> > Is there a place I can get a complete reference of Java API. I am looking  
> > at  
> > [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/en/elasticsearch/client/java-api/current/index_.html) but  
> > it looks like it doesn't provide complete guide. For instance how do I know  
> > if a document was indexed successfully using IndexResponse object?
> > 
> > --  
> > You received this message because you are subscribed to the Google Groups  
> > "elasticsearch" group.  
> > To unsubscribe from this group and stop receiving emails from it, send an  
> > email to [elasticsearch+unsubscribe@googlegroups.com](mailto:elasticsearch+unsubscribe@googlegroups.com).  
> > For more options, visit [https://groups.google.com/groups/opt\_out](https://groups.google.com/groups/opt_out).
> 
> --  
> You received this message because you are subscribed to the Google Groups  
> "elasticsearch" group.  
> To unsubscribe from this group and stop receiving emails from it, send an  
> email to [elasticsearch+unsubscribe@googlegroups.com](mailto:elasticsearch+unsubscribe@googlegroups.com).  
> For more options, visit [https://groups.google.com/groups/opt\_out](https://groups.google.com/groups/opt_out).

--  
You received this message because you are subscribed to the Google Groups "elasticsearch" group.  
To unsubscribe from this group and stop receiving emails from it, send an email to [elasticsearch+unsubscribe@googlegroups.com](mailto:elasticsearch+unsubscribe@googlegroups.com).  
For more options, visit [https://groups.google.com/groups/opt\_out](https://groups.google.com/groups/opt_out).

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/elastic/original/3X/1/a/1ac57faf039f6b580b3f104ef42a2a89e41014de.png) [@system](https://discuss.elastic.co/u/system)\
**Post date:** [July 6, 2017, 2:08am UTC](https://discuss.elastic.co/t/complete-reference-of-java-api/14314/4 "2017-07-06T02:08:16Z")

</div>


