Add option to set headers and sort options in cat requests (#412)

* Adding x-amz-content-sha256 header for signed requests (#339) * Adding X-Amz-Content-Sha256 header for signed requests Signed-off-by: Vacha Shah <[email protected]> * Adding CHANGELOG entry Signed-off-by: Vacha Shah <[email protected]> * Adding documentation comment Signed-off-by: Vacha Shah <[email protected]> * Adding tests Signed-off-by: Vacha Shah <[email protected]> * Addressing comments Signed-off-by: Vacha Shah <[email protected]> * Addressing comments Signed-off-by: Vacha Shah <[email protected]> * Removing refresh policy for integ tests for Sigv4 Signed-off-by: Vacha Shah <[email protected]> * Updating the developer guide Signed-off-by: Vacha Shah <[email protected]> Signed-off-by: Vacha Shah <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Fix issue with completion suggester being parsed as term suggester. (#347) * Fix issue with completion suggester being parsed as term suggester. This commit fixes the issue where a completion suggester search request was being parsed as a term suggester and failing due to "Missing required property 'TermSuggestOption.score'" This solution was originally proposed by Github user @apatrida Signed-off-by: Dan Hart <[email protected]> * Remove commented code Signed-off-by: Dan Hart <[email protected]> * Fix format of changelog item Signed-off-by: Dan Hart <[email protected]> Signed-off-by: Dan Hart <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Update USER_GUIDE to use exact AWS brand names (#352) Minor update to use exact brand names. "OpenSearch" is rather overloaded to I find it less confusing to be precise in the naming. Signed-off-by: Andrew Ross <[email protected]> Signed-off-by: Andrew Ross <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Bumps Jackson from 2.14.1 to 2.14.2 (#357) Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Bulk UpdateOperation misses upsert options (#353) * Bulk UpdateOperation misses upsert options Signed-off-by: Andriy Redko <[email protected]> * Fix formatting Signed-off-by: Andriy Redko <[email protected]> --------- Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Upgrading compatibility to opensearch 2.5 (#367) * Upgrading compatibility to opensearch 2.5 Signed-off-by: amitai stern <[email protected]> * latest 2.4 version Signed-off-by: amitai stern <[email protected]> * keep existing compatibility matrix rows, this pr adds a new row for versions of opensearch after 2.3.0 Signed-off-by: amitai stern <[email protected]> --------- Signed-off-by: amitai stern <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * add option to set columns into cat indices request Signed-off-by: MarinaRazumovsky <[email protected]> * add changelog Signed-off-by: MarinaRazumovsky <[email protected]> * changes in CatRequestBase, IndicesRequest, NodesRequest, RecoveryRequest and add tests Signed-off-by: MarinaRazumovsky <[email protected]> * Feature/range aggregation fix 369 (#370) * test: create integration tests for date_range and range aggregation (#369) Signed-off-by: Dominik Szczepanczyk <[email protected]> * fix: add a missing key propery to the RangeBucket (#369) Signed-off-by: Dominik Szczepanczyk <[email protected]> * docs: add CHANGELOG entry (#369) Signed-off-by: Dominik Szczepanczyk <[email protected]> --------- Signed-off-by: Dominik Szczepanczyk <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Fixing integration tests (#375) * Fixing integration tests Signed-off-by: Vacha Shah <[email protected]> * Updating the test with a non-exact check Signed-off-by: Vacha Shah <[email protected]> --------- Signed-off-by: Vacha Shah <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Adding bulk request example in user guide (#373) Signed-off-by: Vacha Shah <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Fixing issue when tracktotalhits is disabled (#372) * Fixing issue when tracktotalhits is disabled Signed-off-by: Vacha Shah <[email protected]> * Update Changelog Signed-off-by: Vacha Shah <[email protected]> --------- Signed-off-by: Vacha Shah <[email protected]> Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * changes changelog Signed-off-by: MarinaRazumovsky <[email protected]> * Bump io.github.classgraph:classgraph from 4.8.154 to 4.8.156 (#390) * Bump io.github.classgraph:classgraph from 4.8.154 to 4.8.156 Bumps [io.github.classgraph:classgraph](https://github.com/classgraph/classgraph) from 4.8.154 to 4.8.156. - [Release notes](https://github.com/classgraph/classgraph/releases) - [Commits](classgraph/classgraph@classgraph-4.8.154...classgraph-4.8.156) --- updated-dependencies: - dependency-name: io.github.classgraph:classgraph dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * Update changelog Signed-off-by: dependabot[bot] <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Signed-off-by: MarinaRazumovsky <[email protected]> * Add 2PR approval to release workflow (#383) Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Adding an example to use raw JSON class instead of target classes (#385) Signed-off-by: Vacha Shah <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Update Gradle to 8.0.2 (#392) Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Add "mappings" field to IndexSettings object (#382) Signed-off-by: Ilya Lukyanovich <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Created untriaged issue workflow. (#364) Signed-off-by: dblock <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Bump io.github.classgraph:classgraph from 4.8.156 to 4.8.157 in /java-client (#403) * Bump io.github.classgraph:classgraph in /java-client Bumps [io.github.classgraph:classgraph](https://github.com/classgraph/classgraph) from 4.8.156 to 4.8.157. - [Release notes](https://github.com/classgraph/classgraph/releases) - [Commits](classgraph/classgraph@classgraph-4.8.156...classgraph-4.8.157) --- updated-dependencies: - dependency-name: io.github.classgraph:classgraph dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * Update changelog Signed-off-by: dependabot[bot] <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Signed-off-by: MarinaRazumovsky <[email protected]> * Add buffered lookahead for Jackson (#338) Signed-off-by: luneo7 <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * Mask env values for snapshots (#411) Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> * option to set headers and sort into cat requests Signed-off-by: MarinaRazumovsky <[email protected]> * fix test Signed-off-by: MarinaRazumovsky <[email protected]> * fix changelog Signed-off-by: MarinaRazumovsky <[email protected]> * add cat examples into USER_GUID Signed-off-by: MarinaRazumovsky <[email protected]> --------- Signed-off-by: Vacha Shah <[email protected]> Signed-off-by: MarinaRazumovsky <[email protected]> Signed-off-by: Dan Hart <[email protected]> Signed-off-by: Andrew Ross <[email protected]> Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: amitai stern <[email protected]> Signed-off-by: Dominik Szczepanczyk <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: Ilya Lukyanovich <[email protected]> Signed-off-by: dblock <[email protected]> Signed-off-by: luneo7 <[email protected]> Co-authored-by: Vacha Shah <[email protected]> Co-authored-by: Danny Hart <[email protected]> Co-authored-by: Andrew Ross <[email protected]> Co-authored-by: Andriy Redko <[email protected]> Co-authored-by: amitai stern <[email protected]> Co-authored-by: szczepanczykd <[email protected]> Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Co-authored-by: Sayali Gaikawad <[email protected]> Co-authored-by: Ilya Lukyanovich <[email protected]> Co-authored-by: Lucas Rogerio Caetano Ferreira <[email protected]>
opensearch-project · Mar 21, 2023 · 938170a · 938170a
1 parent b69a76a
commit 938170a
Show file tree

Hide file tree

Showing 27 changed files with 1,153 additions and 801 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Require two maintainers to approve release ([#383](https://github.com/opensearch-project/opensearch-java/pull/383))
 - Add support for mapping limit settings ([#382](https://github.com/opensearch-project/opensearch-java/pull/382))
 - Add buffered lookahead for Jackson ([#338](https://github.com/opensearch-project/opensearch-java/pull/338))
+- Add support for headers and sort parameters in cat requests ([#388](https://github.com/opensearch-project/opensearch-java/issues/388))
 
 ### Dependencies
 - Bumps `classgraph` from 4.8.149 to 4.8.154

diff --git a/USER_GUIDE.md b/USER_GUIDE.md
@@ -15,6 +15,10 @@
   - [Aggregations](#aggregations)
   - [Delete the document](#delete-the-document)
   - [Delete the index](#delete-the-index)
+  - [Cat API](#cat-api)
+    - [Cat Indices](#cat-indices)
+    - [Cat Aliases](#cat-aliases)
+    - [Cat Nodes](#cat-nodes)
 - [Using different transport options](#using-different-transport-options)
   - [Amazon OpenSearch Service](#amazon-opensearch-service)
 
@@ -210,6 +214,31 @@ DeleteIndexRequest deleteIndexRequest = new DeleteRequest.Builder().index(index)
 DeleteIndexResponse deleteIndexResponse = client.indices().delete(deleteIndexRequest);
 ```
 
+## Cat API
+
+### Cat Indices
+The following sample code cat indices with required headers and sorted by creation date
+
+```java
+IndicesRequest indicesRequest = new IndicesRequest.Builder()
+        .headers("index,health,status,pri,rep,doc.count,creation.date,creation.date.string").sort("creation.date").build();
+IndicesResponse indicesResponse = javaClient().cat().indices(indicesRequest);
+```
+
+
+### Cat aliases
+The following sample code cat aliases with name "test-alias" and sorted by index
+```java
+AliasesRequest aliasesRequest = new AliasesRequest.Builder().name("test-alias").sort("index").build();
+AliasesResponse aliasesResponse = javaClient().cat().aliases(aliasesRequest);
+```
+
+### Cat nodes
+The following sample code cat nodes sorted by cpu
+```java
+NodesResponse nodesResponse = javaClient().cat().nodes(r -> r.sort("cpu"));
+```
+
 # Using different transport options
 
 ## Amazon OpenSearch Service

diff --git a/java-client/src/main/java/org/opensearch/client/opensearch/cat/AliasesRequest.java b/java-client/src/main/java/org/opensearch/client/opensearch/cat/AliasesRequest.java
@@ -42,14 +42,13 @@
 import org.opensearch.client.transport.endpoints.SimpleEndpoint;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
-import org.opensearch.client.util.ObjectBuilderBase;
 
+import javax.annotation.Nullable;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Collectors;
-import javax.annotation.Nullable;
 
 // typedef: cat.aliases.Request
 
@@ -67,7 +66,7 @@ public class AliasesRequest extends CatRequestBase {
 	// ---------------------------------------------------------------------------------------------
 
 	private AliasesRequest(Builder builder) {
-
+		super(builder);
 		this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
 		this.name = ApiTypeHelper.unmodifiable(builder.name);
 
@@ -102,7 +101,7 @@ public final List<String> name() {
 	 * Builder for {@link AliasesRequest}.
 	 */
 
-	public static class Builder extends ObjectBuilderBase implements ObjectBuilder<AliasesRequest> {
+	public static class Builder extends CatRequestBaseBuilder<AliasesRequest.Builder> {
 		@Nullable
 		private List<ExpandWildcard> expandWildcards;
 
@@ -170,6 +169,11 @@ public AliasesRequest build() {
 
 			return new AliasesRequest(this);
 		}
+
+		@Override
+		protected Builder self() {
+			return this;
+		}
 	}
 
 	// ---------------------------------------------------------------------------------------------
@@ -214,8 +218,7 @@ public AliasesRequest build() {
 
 			// Request parameters
 			request -> {
-				Map<String, String> params = new HashMap<>();
-				params.put("format", "json");
+				Map<String, String> params = new HashMap<>(request.queryParameters());
 				if (ApiTypeHelper.isDefined(request.expandWildcards)) {
 					params.put("expand_wildcards",
 							request.expandWildcards.stream()

diff --git a/java-client/src/main/java/org/opensearch/client/opensearch/cat/AllocationRequest.java b/java-client/src/main/java/org/opensearch/client/opensearch/cat/AllocationRequest.java
@@ -42,14 +42,13 @@
 import org.opensearch.client.transport.endpoints.SimpleEndpoint;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
-import org.opensearch.client.util.ObjectBuilderBase;
 
+import javax.annotation.Nullable;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Collectors;
-import javax.annotation.Nullable;
 
 // typedef: cat.allocation.Request
 
@@ -68,7 +67,7 @@ public class AllocationRequest extends CatRequestBase {
 	// ---------------------------------------------------------------------------------------------
 
 	private AllocationRequest(Builder builder) {
-
+		super(builder);
 		this.bytes = builder.bytes;
 		this.nodeId = ApiTypeHelper.unmodifiable(builder.nodeId);
 
@@ -103,7 +102,7 @@ public final List<String> nodeId() {
 	 * Builder for {@link AllocationRequest}.
 	 */
 
-	public static class Builder extends ObjectBuilderBase implements ObjectBuilder<AllocationRequest> {
+	public static class Builder extends CatRequestBaseBuilder<AllocationRequest.Builder> {
 		@Nullable
 		private Bytes bytes;
 
@@ -155,6 +154,11 @@ public AllocationRequest build() {
 
 			return new AllocationRequest(this);
 		}
+
+		@Override
+		protected Builder self() {
+			return this;
+		}
 	}
 
 	// ---------------------------------------------------------------------------------------------
@@ -200,8 +204,7 @@ public AllocationRequest build() {
 
 			// Request parameters
 			request -> {
-				Map<String, String> params = new HashMap<>();
-				params.put("format", "json");
+				Map<String, String> params = new HashMap<>(request.queryParameters());
 				if (request.bytes != null) {
 					params.put("bytes", request.bytes.jsonValue());
 				}

diff --git a/java-client/src/main/java/org/opensearch/client/opensearch/cat/CatRequestBase.java b/java-client/src/main/java/org/opensearch/client/opensearch/cat/CatRequestBase.java
@@ -37,21 +37,99 @@
 package org.opensearch.client.opensearch.cat;
 
 import org.opensearch.client.opensearch._types.RequestBase;
+import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
-// typedef: cat._types.CatRequestBase
+import javax.annotation.Nullable;
+import java.util.HashMap;
+import java.util.Map;
 
+// typedef: cat._types.CatRequestBase
 
 
 public abstract class CatRequestBase extends RequestBase {
-	public CatRequestBase() {
-	}
 
-	protected abstract static class AbstractBuilder<BuilderT extends AbstractBuilder<BuilderT>>
-			extends
-				ObjectBuilderBase {
-		protected abstract BuilderT self();
+    @Nullable
+    private final String headers;
+
+    @Nullable
+    private final String sort;
+
+    public CatRequestBase() {
+        this.headers = null;
+        this.sort = null;
+    }
+
+    public CatRequestBase(CatRequestBaseBuilder<?> builder) {
+        this.headers = builder.headers;
+        this.sort = builder.sort;
+    }
+
+    protected final Map<String, String> queryParameters() {
+        Map<String, String> params = new HashMap<>();
+        if (headers != null && !headers.isBlank()) {
+            params.put("h", headers);
+        }
+        if(sort != null && !sort.isBlank()) {
+            params.put("s", sort);
+        }
+        params.put("format", "json");
+        return params;
+    }
+
+
+    /**
+     * A comma-separated list of headers to limit the returned information
+     * <p>
+     * API name: {@code h}
+     */
+    public final String headers() {
+        return this.headers;
+    }
+
+    /**
+     * A comma-separated list of headers to sort the returned information
+     * <p>
+     * API name: {@code s}
+     * <p>
+     */
+    public final String sort() {
+        return this.sort;
+    }
+
+
+    protected abstract static class CatRequestBaseBuilder<BuilderT extends CatRequestBaseBuilder> extends ObjectBuilderBase implements ObjectBuilder {
+
+        @Nullable
+        protected String headers;
+
+        @Nullable
+        protected String sort;
+
+        protected abstract BuilderT self();
+
+        /**
+         * A comma-separated list of specific headers to limits the output
+         * <p>
+         * API name: {@code h}
+         * <p>
+         */
+        public final BuilderT headers(@Nullable String headers) {
+            this.headers = headers;
+            return self();
+        }
+
+        /**
+         * A comma-separated list of headers to sort the returned information
+         * <p>
+         * API name: {@code s}
+         * <p>
+         */
+        public final BuilderT sort(@Nullable String sort) {
+            this.sort = sort;
+            return self();
+        }
 
-	}
+    }
 
 }
diff --git a/java-client/src/main/java/org/opensearch/client/opensearch/cat/ClusterManagerRequest.java b/java-client/src/main/java/org/opensearch/client/opensearch/cat/ClusterManagerRequest.java
@@ -41,7 +41,6 @@
 import org.opensearch.client.transport.endpoints.SimpleEndpoint;
 
 import java.util.HashMap;
-import java.util.Map;
 
 // typedef: cat.cluster_manager.Request
 
@@ -79,12 +78,7 @@ public ClusterManagerRequest() {
 			},
 
 			// Request parameters
-			request -> {
-				Map<String, String> params = new HashMap<>();
-				params.put("format", "json");
-				return params;
-
-			}, SimpleEndpoint.emptyMap(), false, ClusterManagerResponse._DESERIALIZER);
+			request -> new HashMap<>(request.queryParameters()), SimpleEndpoint.emptyMap(), false, ClusterManagerResponse._DESERIALIZER);
 
 	/**
 	 * Endpoint "{@code cat.cluster_manager}".
@@ -104,10 +98,5 @@ public ClusterManagerRequest() {
 			},
 
 			// Request parameters
-			request -> {
-				Map<String, String> params = new HashMap<>();
-				params.put("format", "json");
-				return params;
-
-			}, SimpleEndpoint.emptyMap(), false, ClusterManagerResponse._DESERIALIZER);
+			request -> new HashMap<>(request.queryParameters()), SimpleEndpoint.emptyMap(), false, ClusterManagerResponse._DESERIALIZER);
 }
diff --git a/java-client/src/main/java/org/opensearch/client/opensearch/cat/CountRequest.java b/java-client/src/main/java/org/opensearch/client/opensearch/cat/CountRequest.java
@@ -41,14 +41,12 @@
 import org.opensearch.client.transport.endpoints.SimpleEndpoint;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
-import org.opensearch.client.util.ObjectBuilderBase;
 
+import javax.annotation.Nullable;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Collectors;
-import javax.annotation.Nullable;
 
 // typedef: cat.count.Request
 
@@ -64,7 +62,7 @@ public class CountRequest extends CatRequestBase {
 	// ---------------------------------------------------------------------------------------------
 
 	private CountRequest(Builder builder) {
-
+		super(builder);
 		this.index = ApiTypeHelper.unmodifiable(builder.index);
 
 	}
@@ -88,7 +86,7 @@ public final List<String> index() {
 	 * Builder for {@link CountRequest}.
 	 */
 
-	public static class Builder extends ObjectBuilderBase implements ObjectBuilder<CountRequest> {
+	public static class Builder extends CatRequestBaseBuilder<CountRequest.Builder> {
 		@Nullable
 		private List<String> index;
 
@@ -127,6 +125,11 @@ public CountRequest build() {
 
 			return new CountRequest(this);
 		}
+
+		@Override
+		protected Builder self() {
+			return this;
+		}
 	}
 
 	// ---------------------------------------------------------------------------------------------
@@ -170,10 +173,5 @@ public CountRequest build() {
 			},
 
 			// Request parameters
-			request -> {
-				Map<String, String> params = new HashMap<>();
-				params.put("format", "json");
-				return params;
-
-			}, SimpleEndpoint.emptyMap(), false, CountResponse._DESERIALIZER);
+			request -> new HashMap<>(request.queryParameters()), SimpleEndpoint.emptyMap(), false, CountResponse._DESERIALIZER);
 }