# Elasticsearch java api reference **URL:** \ **Category:** Elasticsearch\ **Created:** [February 18, 2013, 1:30pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776 "2013-02-18T13:30:31Z")\ **Posts on this page:** 10\ **Page:** 1
**Author:** ![Ulli](https://avatars.discourse-cdn.com/v4/letter/u/f04885/32.png) [@Ulli](https://discuss.elastic.co/u/Ulli)\ **Post date:** [February 18, 2013, 1:30pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/1 "2013-02-18T13:30:31Z")
Hi, Where do I find a 'real' elasticsearch java api reference? Not just some examples of a few classes like here: [http://www.elasticsearch.org/guide/reference/java-api/](http://www.elasticsearch.org/guide/reference/java-api/) Thanks in advance Ulli -- 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). ---
**Author:** ![Ulli](https://avatars.discourse-cdn.com/v4/letter/u/f04885/32.png) [@Ulli](https://discuss.elastic.co/u/Ulli)\ **Post date:** [February 19, 2013, 8:49am UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/2 "2013-02-19T08:49:21Z")
Um, is there really no api reference? Am Montag, 18. Februar 2013 14:30:31 UTC+1 schrieb Ulli: > Hi, > > Where do I find a 'real' elasticsearch java api reference? Not just some > examples of a few classes like here: > [http://www.elasticsearch.org/guide/reference/java-api/](http://www.elasticsearch.org/guide/reference/java-api/) > > Thanks in advance > Ulli -- 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). ---
**Author:** ![Andrej](https://avatars.discourse-cdn.com/v4/letter/a/d9b06d/32.png) [@Andrej](https://discuss.elastic.co/u/Andrej)\ **Post date:** [February 19, 2013, 12:59pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/3 "2013-02-19T12:59:10Z")
No, looks like there isnt (and believe me, I searched for it ;-)) Until several versions ago there were at least javadocs available for download, but this disappeared somehow. Solution is the classical do it yourself approach: download source and generate javadoc. What helped me in the past was: 1. searching this mailing list and 2. read the the source code, usually you can figure out pretty good what is going on when looking at how rest requests are transformed into java api calls or what is covered in the test cases. Am Dienstag, 19. Februar 2013 09:49:21 UTC+1 schrieb Ulli: > Um, is there really no api reference? > > Am Montag, 18. Februar 2013 14:30:31 UTC+1 schrieb Ulli: > > > Hi, > > > > Where do I find a 'real' elasticsearch java api reference? Not just some > > examples of a few classes like here: > > [http://www.elasticsearch.org/guide/reference/java-api/](http://www.elasticsearch.org/guide/reference/java-api/) > > > > Thanks in advance > > Ulli -- 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). ---
**Author:** ![Jon\_Shea](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/jon_shea/32/2263_2.png) [@Jon\_Shea](https://discuss.elastic.co/u/Jon_Shea)\ **Post date:** [February 19, 2013, 3:57pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/4 "2013-02-19T15:57:40Z")
There is not much in the way of Java API reference, but the Java API closely mirrors the JSON API. In practice, I usually figure out what I want to do in the JSON API, and then find the corresponding Java API helper methods in the Elasticsearch source code. It’s not ideal, but it also isn’t too time consuming. Would Elasticsearch be open to accepting documentation patches for the query API that included examples in Java? -Jon -- 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). ---
**Author:** ![egaumer](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/egaumer/32/2365_2.png) [@egaumer](https://discuss.elastic.co/u/egaumer)\ **Post date:** [February 19, 2013, 4:05pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/5 "2013-02-19T16:05:45Z")
The JSON API does indeed closely resemble the Java API. The elastic.js library takes advantage of that fact and provides comprehensive documentation of the query DSL. [http://docs.fullscale.co/elasticjs/](http://docs.fullscale.co/elasticjs/) On Tuesday, February 19, 2013 10:57:40 AM UTC-5, Jon Shea wrote: > There is not much in the way of Java API reference, but the Java API > closely mirrors the JSON API. In practice, I usually figure out what I want > to do in the JSON API, and then find the corresponding Java API helper > methods in the Elasticsearch source code. It’s not ideal, but it also isn’t > too time consuming. > > Would Elasticsearch be open to accepting documentation patches for the > query API that included examples in Java? > > -Jon -- 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). ---
**Author:** ![dadoonet](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/dadoonet/32/137187_2.png) [@dadoonet](https://discuss.elastic.co/u/dadoonet)\ **Post date:** [February 19, 2013, 4:07pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/6 "2013-02-19T16:07:05Z")
Heya, We pushed already some recent updates in the Java documentation. We described Queries [1] , Filters [2] and Facets [3] in Java. Can you describe what you would like to have in addition of that? [1] [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/query-dsl-queries.html) [2] [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/query-dsl-filters.html) [3] [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/facets.html) -- David Pilato | Technical Advocate | [Elasticsearch.com](http://Elasticsearch.com) @dadoonet | @elasticsearchfr | @scrutmydocs Le 19 févr. 2013 à 16:57, Jon Shea [jonshea@foursquare.com](mailto:jonshea@foursquare.com) a écrit : > There is not much in the way of Java API reference, but the Java API closely mirrors the JSON API. In practice, I usually figure out what I want to do in the JSON API, and then find the corresponding Java API helper methods in the Elasticsearch source code. It’s not ideal, but it also isn’t too time consuming. > > Would Elasticsearch be open to accepting documentation patches for the query API that included examples in Java? > > -Jon > > -- > 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). ---
**Author:** ![Jon\_Shea](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/jon_shea/32/2263_2.png) [@Jon\_Shea](https://discuss.elastic.co/u/Jon_Shea)\ **Post date:** [February 19, 2013, 4:21pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/7 "2013-02-19T16:21:41Z")
On Tuesday, February 19, 2013 at 11:07 AM, David Pilato wrote: > Can you describe what you would like to have in addition of that? Hi David, Wow, those are really great improvements. I noticed someone was committing new Java documentation, but I hadn’t realized how far along it had come. Thanks, it looks really great. I was imagining that in the query-dsl section of the documentation ([Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/query-dsl/)) each JSON example could have a corresponding Java example, either beneath it or linked from it. But I think the way things are set up now could work too, if I get in the habit of looking at the java-api documentation rather than just skipping sight to the Elasticsearch source. -Jon -- 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). ---
**Author:** ![Andrej](https://avatars.discourse-cdn.com/v4/letter/a/d9b06d/32.png) [@Andrej](https://discuss.elastic.co/u/Andrej)\ **Post date:** [February 19, 2013, 4:38pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/8 "2013-02-19T16:38:45Z")
Those updates are for sure an improvement, thanks once again! What comes to my mind what would be still interesting:. 1. ready to use/download javadocs (with maybe a little bit more docs inside) 😉 2. maybe a short tutorial like guide how to make use of metadata (what is included, how to resolving aliases, getting mapping information, etc.). I believe new users would benefit, this is not really straight forward or at least it took me quite some time to puzzle it out. Thanks! Andrej Am Dienstag, 19. Februar 2013 17:07:05 UTC+1 schrieb David Pilato: > Heya, > > We pushed already some recent updates in the Java documentation. > We described Queries [1] , Filters [2] and Facets [3] in Java. > > Can you describe what you would like to have in addition of that? > > [1] > [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/query-dsl-queries.html) > [2] > [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/query-dsl-filters.html) > [3] [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/facets.html) > > -- > _David Pilato_ | _Technical Advocate_ | _[Elasticsearch.com](http://Elasticsearch.com)_ > @dadoonet [https://twitter.com/dadoonet](https://twitter.com/dadoonet) | @elasticsearchfr[https://twitter.com/elasticsearchfr](https://twitter.com/elasticsearchfr) > | @scrutmydocs [https://twitter.com/scrutmydocs](https://twitter.com/scrutmydocs) > > Le 19 févr. 2013 à 16:57, Jon Shea \<[jon...@foursquare.com](mailto:jon...@foursquare.com) \\> > a écrit : > > There is not much in the way of Java API reference, but the Java API > closely mirrors the JSON API. In practice, I usually figure out what I want > to do in the JSON API, and then find the corresponding Java API helper > methods in the Elasticsearch source code. It’s not ideal, but it also isn’t > too time consuming. > > Would Elasticsearch be open to accepting documentation patches for the > query API that included examples in Java? > > -Jon > > -- > 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 [elasticsearc...@googlegroups.com](mailto:elasticsearc...@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). ---
**Author:** ![dadoonet](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/dadoonet/32/137187_2.png) [@dadoonet](https://discuss.elastic.co/u/dadoonet)\ **Post date:** [February 19, 2013, 4:42pm UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/9 "2013-02-19T16:42:50Z")
+1 for all admin commands in Java. I add it to my ToDo list. For Javadocs, you can attach source code to your project. [https://oss.sonatype.org/content/repositories/releases/org/elasticsearch/elasticsearch/0.20.5/](https://oss.sonatype.org/content/repositories/releases/org/elasticsearch/elasticsearch/0.20.5/) It's not direct Javadoc for sure but should help at least. -- David Pilato | Technical Advocate | [Elasticsearch.com](http://Elasticsearch.com) @dadoonet | @elasticsearchfr | @scrutmydocs Le 19 févr. 2013 à 17:38, Andrej Rosenheinrich [andrej.rosenheinrich@unister.de](mailto:andrej.rosenheinrich@unister.de) a écrit : > Those updates are for sure an improvement, thanks once again! What comes to my mind what would be still interesting:. 1. ready to use/download javadocs (with maybe a little bit more docs inside) 😉 2. maybe a short tutorial like guide how to make use of metadata (what is included, how to resolving aliases, getting mapping information, etc.). I believe new users would benefit, this is not really straight forward or at least it took me quite some time to puzzle it out. > > Thanks! > Andrej > > Am Dienstag, 19. Februar 2013 17:07:05 UTC+1 schrieb David Pilato: > Heya, > > We pushed already some recent updates in the Java documentation. > We described Queries [1] , Filters [2] and Facets [3] in Java. > > Can you describe what you would like to have in addition of that? > > [1] [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/query-dsl-queries.html) > [2] [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/query-dsl-filters.html) > [3] [Elasticsearch Platform — Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/java-api/facets.html) > > -- > David Pilato | Technical Advocate | [Elasticsearch.com](http://Elasticsearch.com) > @dadoonet | @elasticsearchfr | @scrutmydocs > > Le 19 févr. 2013 à 16:57, Jon Shea [jon...@foursquare.com](mailto:jon...@foursquare.com) a écrit : > > > There is not much in the way of Java API reference, but the Java API closely mirrors the JSON API. In practice, I usually figure out what I want to do in the JSON API, and then find the corresponding Java API helper methods in the Elasticsearch source code. It’s not ideal, but it also isn’t too time consuming. > > > > Would Elasticsearch be open to accepting documentation patches for the query API that included examples in Java? > > > > -Jon > > > > -- > > 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 [elasticsearc...@googlegroups.com](mailto:elasticsearc...@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). ---
**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:50am UTC](https://discuss.elastic.co/t/elasticsearch-java-api-reference/10776/10 "2017-07-06T02:50:41Z")