From 476e2d6422df45430decaf189707a642ef528f5d Mon Sep 17 00:00:00 2001 From: Vacha Shah Date: Tue, 15 Aug 2023 13:00:32 -0700 Subject: [PATCH] Correcting the java client code snippets and updating java client version (#4789) Signed-off-by: Vacha Shah --- _clients/java.md | 107 ++++++++++++++++++++--------------------------- 1 file changed, 46 insertions(+), 61 deletions(-) diff --git a/_clients/java.md b/_clients/java.md index 43c39b46..2b8c776d 100644 --- a/_clients/java.md +++ b/_clients/java.md @@ -18,7 +18,7 @@ To start using the OpenSearch Java client, you need to provide a transport. The org.opensearch.client opensearch-java - 2.4.0 + 2.6.0 ``` {% include copy.html %} @@ -27,7 +27,7 @@ If you're using Gradle, add the following dependencies to your project: ``` dependencies { - implementation 'org.opensearch.client:opensearch-java:2.4.0' + implementation 'org.opensearch.client:opensearch-java:2.6.0' } ``` {% include copy.html %} @@ -48,7 +48,7 @@ Alternatively, you can create a Java client by using the `RestClient`-based tran org.opensearch.client opensearch-java - 2.4.0 + 2.6.0 ``` {% include copy.html %} @@ -58,7 +58,7 @@ If you're using Gradle, add the following dependencies to your project" ``` dependencies { implementation 'org.opensearch.client:opensearch-rest-client:{{site.opensearch_version}}' - implementation 'org.opensearch.client:opensearch-java:2.4.0' + implementation 'org.opensearch.client:opensearch-java:2.6.0' } ``` {% include copy.html %} @@ -291,7 +291,7 @@ You can create an index with non-default settings using the following code: ```java String index = "sample-index"; -CreateRequest createIndexRequest = new CreateRequest.Builder().index(index).build(); +CreateIndexRequest createIndexRequest = new CreateIndexRequest.Builder().index(index).build(); client.indices().create(createIndexRequest); IndexSettings indexSettings = new IndexSettings.Builder().autoExpandReplicas("0-all").build(); @@ -338,22 +338,8 @@ client.delete(b -> b.index(index).id("1")); The following sample code deletes an index: ```java -DeleteRequest deleteRequest = new DeleteRequest.Builder().index(index).build(); -DeleteResponse deleteResponse = client.indices().delete(deleteRequest); - -} catch (IOException e){ - System.out.println(e.toString()); -} finally { - try { - if (restClient != null) { - restClient.close(); - } - } catch (IOException e) { - System.out.println(e.toString()); - } - } - } -} +DeleteIndexRequest deleteIndexRequest = new DeleteRequest.Builder().index(index).build(); +DeleteIndexResponse deleteIndexResponse = client.indices().delete(deleteIndexRequest); ``` {% include copy.html %} @@ -386,54 +372,53 @@ public class OpenSearchClientExample { public static void main(String[] args) { RestClient restClient = null; try{ - System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore"); - System.setProperty("javax.net.ssl.trustStorePassword", "password-to-keystore"); + System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore"); + System.setProperty("javax.net.ssl.trustStorePassword", "password-to-keystore"); - //Only for demo purposes. Don't specify your credentials in code. - final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); - credentialsProvider.setCredentials(AuthScope.ANY, - new UsernamePasswordCredentials("admin", "admin")); + //Only for demo purposes. Don't specify your credentials in code. + final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); + credentialsProvider.setCredentials(AuthScope.ANY, + new UsernamePasswordCredentials("admin", "admin")); - //Initialize the client with SSL and TLS enabled - restClient = RestClient.builder(new HttpHost("localhost", 9200, "https")). - setHttpClientConfigCallback(new RestClientBuilder.HttpClientConfigCallback() { - @Override - public HttpAsyncClientBuilder customizeHttpClient(HttpAsyncClientBuilder httpClientBuilder) { - return httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider); - } - }).build(); - Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper()); - OpenSearchClient client = new OpenSearchClient(transport); + //Initialize the client with SSL and TLS enabled + restClient = RestClient.builder(new HttpHost("localhost", 9200, "https")). + setHttpClientConfigCallback(new RestClientBuilder.HttpClientConfigCallback() { + @Override + public HttpAsyncClientBuilder customizeHttpClient(HttpAsyncClientBuilder httpClientBuilder) { + return httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider); + } + }).build(); + Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper()); + OpenSearchClient client = new OpenSearchClient(transport); - //Create the index - String index = "sample-index"; - CreateRequest createIndexRequest = new CreateRequest.Builder().index(index).build(); - client.indices().create(createIndexRequest); + //Create the index + String index = "sample-index"; + CreateIndexRequest createIndexRequest = new CreateIndexRequest.Builder().index(index).build(); + client.indices().create(createIndexRequest); - //Add some settings to the index - IndexSettings indexSettings = new IndexSettings.Builder().autoExpandReplicas("0-all").build(); - IndexSettingsBody settingsBody = new IndexSettingsBody.Builder().settings(indexSettings).build(); - PutSettingsRequest putSettingsRequest = new PutSettingsRequest.Builder().index(index).value(settingsBody).build(); - client.indices().putSettings(putSettingsRequest); + //Add some settings to the index + IndexSettings indexSettings = new IndexSettings.Builder().autoExpandReplicas("0-all").build(); + IndexSettingsBody settingsBody = new IndexSettingsBody.Builder().settings(indexSettings).build(); + PutSettingsRequest putSettingsRequest = new PutSettingsRequest.Builder().index(index).value(settingsBody).build(); + client.indices().putSettings(putSettingsRequest); - //Index some data - IndexData indexData = new IndexData("first_name", "Bruce"); - IndexRequest indexRequest = new IndexRequest.Builder().index(index).id("1").document(indexData).build(); - client.index(indexRequest); + //Index some data + IndexData indexData = new IndexData("first_name", "Bruce"); + IndexRequest indexRequest = new IndexRequest.Builder().index(index).id("1").document(indexData).build(); + client.index(indexRequest); - //Search for the document - SearchResponse searchResponse = client.search(s -> s.index(index), IndexData.class); - for (int i = 0; i< searchResponse.hits().hits().size(); i++) { - System.out.println(searchResponse.hits().hits().get(i).source()); - } + //Search for the document + SearchResponse searchResponse = client.search(s -> s.index(index), IndexData.class); + for (int i = 0; i< searchResponse.hits().hits().size(); i++) { + System.out.println(searchResponse.hits().hits().get(i).source()); + } - //Delete the document - client.delete(b -> b.index(index).id("1")); - - // Delete the index - DeleteRequest deleteRequest = new DeleteRequest.Builder().index(index).build(); - DeleteResponse deleteResponse = client.indices().delete(deleteRequest); + //Delete the document + client.delete(b -> b.index(index).id("1")); + // Delete the index + DeleteIndexRequest deleteIndexRequest = new DeleteRequest.Builder().index(index).build(); + DeleteIndexResponse deleteIndexResponse = client.indices().delete(deleteIndexRequest); } catch (IOException e){ System.out.println(e.toString()); } finally {