Add Gradle coordinates for the REST client

This commit is contained in:
David Pilato 2016-11-22 16:34:23 +01:00
parent 284dedfb5f
commit 5e1780061c
2 changed files with 39 additions and 12 deletions

View File

@ -8,7 +8,14 @@ Nodes Info api and uses jackson to parse the obtained json response.
Compatible with Elasticsearch 2.x and onwards. Compatible with Elasticsearch 2.x and onwards.
=== Maven Repository The low-level REST client is subject to the same release cycle as
elasticsearch. Replace the version with the desired sniffer version, first
released with `5.0.0-alpha4`. There is no relation between the sniffer version
and the elasticsearch version that the client can communicate with. Sniffer
supports fetching the nodes list from elasticsearch 2.x and onwards.
=== Maven coordinates
Here is how you can configure the dependency using maven as a dependency manager. Here is how you can configure the dependency using maven as a dependency manager.
Add the following to your `pom.xml` file: Add the following to your `pom.xml` file:
@ -22,11 +29,17 @@ Add the following to your `pom.xml` file:
</dependency> </dependency>
-------------------------------------------------- --------------------------------------------------
The low-level REST client is subject to the same release cycle as === Gradle coordinates
elasticsearch. Replace `${es.version}` with the desired sniffer version, first
released with `5.0.0-alpha4`. There is no relation between the sniffer version Here is how you can configure the dependency using gradle as a dependency manager.
and the elasticsearch version that the client can communicate with. Sniffer Add the following to your `build.gradle` file:
supports fetching the nodes list from elasticsearch 2.x and onwards.
["source","groovy",subs="attributes"]
--------------------------------------------------
dependencies {
compile group: 'org.elasticsearch.client', name: 'sniffer', version: '{version}'
}
--------------------------------------------------
=== Usage === Usage

View File

@ -1,11 +1,19 @@
== Getting started == Getting started
=== Maven Repository === Maven Central Repository
The low-level Java REST client is hosted on The low-level Java REST client is hosted on
http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.elasticsearch.client%22[Maven http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.elasticsearch.client%22[Maven
Central]. The minimum Java version required is `1.7`. Central]. The minimum Java version required is `1.7`.
The low-level REST client is subject to the same release cycle as
elasticsearch. Replace the version with the desired client version, first
released with `5.0.0-alpha4`. There is no relation between the client version
and the elasticsearch version that the client can communicate with. The
low-level REST client is compatible with all elasticsearch versions.
=== Maven coordinates
Here is how you can configure the dependency using maven as a dependency manager. Here is how you can configure the dependency using maven as a dependency manager.
Add the following to your `pom.xml` file: Add the following to your `pom.xml` file:
@ -18,11 +26,17 @@ Add the following to your `pom.xml` file:
</dependency> </dependency>
-------------------------------------------------- --------------------------------------------------
The low-level REST client is subject to the same release cycle as === Gradle coordinates
elasticsearch. Replace `${es.version}` with the desired client version, first
released with `5.0.0-alpha4`. There is no relation between the client version Here is how you can configure the dependency using gradle as a dependency manager.
and the elasticsearch version that the client can communicate with. The Add the following to your `build.gradle` file:
low-level REST client is compatible with all elasticsearch versions.
["source","groovy",subs="attributes"]
--------------------------------------------------
dependencies {
compile group: 'org.elasticsearch.client', name: 'rest', version: '{version}'
}
--------------------------------------------------
=== Dependencies === Dependencies