Feature/QueryGroup Add CRUD APIs in plugin

CHANGELOG-3.0.md

@@ -24,6 +24,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add task completion count in search backpressure stats API ([#10028](https://github.com/opensearch-project/OpenSearch/pull/10028/))
 - Deprecate CamelCase `PathHierarchy` tokenizer name in favor to lowercase `path_hierarchy` ([#10894](https://github.com/opensearch-project/OpenSearch/pull/10894))
 - Breaking change: Do not request "search_pipelines" metrics by default in NodesInfoRequest ([#12497](https://github.com/opensearch-project/OpenSearch/pull/12497))
+- [Query Sandbox] Add Resource Limit Group CRUD APIs ([#13315](https://github.com/opensearch-project/OpenSearch/pull/13315))
 
 ### Deprecated
 

plugins/query-resource-limit-group/build.gradle

@@ -0,0 +1,18 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+opensearchplugin {
+  description 'OpenSearch ResourceLimitGroup Plugin.'
+  classname 'org.opensearch.plugin.resource_limit_group.ResourceLimitGroupPlugin'
+}
+
+dependencies {
+}

plugins/query-resource-limit-group/src/main/java/org/opensearch/plugin/resource_limit_group/CreateResourceLimitGroupAction.java

@@ -0,0 +1,36 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.plugin.resource_limit_group;
+
+import org.opensearch.action.ActionType;
+
+/**
+ * Rest action to create Resource Limit Group
+ *
+ * @opensearch.api
+ */
+public class CreateResourceLimitGroupAction extends ActionType<CreateResourceLimitGroupResponse> {
+
+    /**
+     * An instance of CreateResourceLimitGroupAction
+     */
+    public static final CreateResourceLimitGroupAction INSTANCE = new CreateResourceLimitGroupAction();
+
+    /**
+     * Name for CreateResourceLimitGroupAction
+     */
+    public static final String NAME = "cluster:admin/opensearch/resource_limit_group/_create";
+
+    /**
+     * Default constructor
+     */
+    private CreateResourceLimitGroupAction() {
+        super(NAME, CreateResourceLimitGroupResponse::new);
+    }
+}

plugins/query-resource-limit-group/src/main/java/org/opensearch/plugin/resource_limit_group/CreateResourceLimitGroupRequest.java

@@ -0,0 +1,182 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.plugin.resource_limit_group;
+
+import org.opensearch.action.ActionRequest;
+import org.opensearch.action.ActionRequestValidationException;
+import org.opensearch.cluster.metadata.ResourceLimitGroup;
+import org.opensearch.cluster.metadata.ResourceLimitGroup.ResourceLimit;
+import org.opensearch.core.common.io.stream.StreamInput;
+import org.opensearch.core.common.io.stream.StreamOutput;
+import org.opensearch.core.common.io.stream.Writeable;
+import org.opensearch.core.xcontent.XContentParser;
+
+import java.io.IOException;
+import java.util.List;
+
+/**
+ * A request for create Resource Limit Group
+ *
+ * @opensearch.internal
+ */
+public class CreateResourceLimitGroupRequest extends ActionRequest implements Writeable.Reader<CreateResourceLimitGroupRequest> {
+    private String name;
+    private String uuid;
+    private List<ResourceLimit> resourceLimits;
+    private String enforcement;
+    private String createdAt;
+    private String updatedAt;
+
+    /**
+     * Default constructor for CreateResourceLimitGroupRequest
+     */
+    public CreateResourceLimitGroupRequest() {}
+
+    /**
+     * Constructor for CreateResourceLimitGroupRequest
+     * @param resourceLimitGroup - A {@link ResourceLimitGroup} object
+     */
+    public CreateResourceLimitGroupRequest(ResourceLimitGroup resourceLimitGroup) {
+        this.name = resourceLimitGroup.getName();
+        this.uuid = resourceLimitGroup.getUUID();
+        this.resourceLimits = resourceLimitGroup.getResourceLimits();
+        this.enforcement = resourceLimitGroup.getEnforcement();
+        this.createdAt = resourceLimitGroup.getCreatedAt();
+        this.updatedAt = resourceLimitGroup.getUpdatedAt();
+    }
+
+    /**
+     * Constructor for CreateResourceLimitGroupRequest
+     * @param in - A {@link StreamInput} object
+     */
+    public CreateResourceLimitGroupRequest(StreamInput in) throws IOException {
+        super(in);
+        name = in.readString();
+        uuid = in.readString();
+        resourceLimits = in.readList(ResourceLimit::new);
+        enforcement = in.readString();
+        createdAt = in.readString();
+        updatedAt = in.readString();
+    }
+
+    @Override
+    public CreateResourceLimitGroupRequest read(StreamInput in) throws IOException {
+        return new CreateResourceLimitGroupRequest(in);
+    }
+
+    /**
+     * Generate a CreateResourceLimitGroupRequest from XContent
+     * @param parser - A {@link XContentParser} object
+     */
+    public static CreateResourceLimitGroupRequest fromXContent(XContentParser parser) throws IOException {
+        ResourceLimitGroup resourceLimitGroup = ResourceLimitGroup.fromXContent(parser);
+        return new CreateResourceLimitGroupRequest(resourceLimitGroup);
+    }
+
+    @Override
+    public ActionRequestValidationException validate() {
+        return null;
+    }
+
+    /**
+     * name getter
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * name setter
+     * @param name - name to be set
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * resourceLimits getter
+     */
+    public List<ResourceLimit> getResourceLimits() {
+        return resourceLimits;
+    }
+
+    /**
+     * resourceLimits setter
+     * @param resourceLimits - resourceLimit to be set
+     */
+    public void setResourceLimits(List<ResourceLimit> resourceLimits) {
+        this.resourceLimits = resourceLimits;
+    }
+
+    /**
+     * Enforcement getter
+     */
+    public String getEnforcement() {
+        return enforcement;
+    }
+
+    /**
+     * Enforcement setter
+     * @param enforcement - enforcement to be set
+     */
+    public void setEnforcement(String enforcement) {
+        this.enforcement = enforcement;
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+        ResourceLimitGroup.writeToOutputStream(out, name, uuid, resourceLimits, enforcement, createdAt, updatedAt);
+    }
+
+    /**
+     * UUID getter
+     */
+    public String getUUID() {
+        return uuid;
+    }
+
+    /**
+     * UUID setter
+     * @param uuid - uuid to be set
+     */
+    public void setUUID(String uuid) {
+        this.uuid = uuid;
+    }
+
+    /**
+     * createdAt getter
+     */
+    public String getCreatedAt() {
+        return createdAt;
+    }
+
+    /**
+     * createdAt setter
+     * @param createdAt - createdAt to be set
+     */
+    public void setCreatedAt(String createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    /**
+     * updatedAt getter
+     */
+    public String getUpdatedAt() {
+        return updatedAt;
+    }
+
+    /**
+     * updatedAt setter
+     * @param updatedAt - updatedAt to be set
+     */
+    public void setUpdatedAt(String updatedAt) {
+        this.updatedAt = updatedAt;
+    }
+}

plugins/query-resource-limit-group/src/main/java/org/opensearch/plugin/resource_limit_group/CreateResourceLimitGroupResponse.java

@@ -0,0 +1,86 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.plugin.resource_limit_group;
+
+import org.opensearch.cluster.metadata.ResourceLimitGroup;
+import org.opensearch.core.action.ActionResponse;
+import org.opensearch.core.common.io.stream.StreamInput;
+import org.opensearch.core.common.io.stream.StreamOutput;
+import org.opensearch.core.rest.RestStatus;
+import org.opensearch.core.xcontent.ToXContent;
+import org.opensearch.core.xcontent.ToXContentObject;
+import org.opensearch.core.xcontent.XContentBuilder;
+
+import java.io.IOException;
+
+/**
+ * Response for the create API for resource limit groups
+ *
+ * @opensearch.internal
+ */
+public class CreateResourceLimitGroupResponse extends ActionResponse implements ToXContent, ToXContentObject {
+    private final ResourceLimitGroup resourceLimitGroup;
+    private RestStatus restStatus;
+
+    /**
+     * Constructor for CreateResourceLimitGroupResponse
+     */
+    public CreateResourceLimitGroupResponse() {
+        this.resourceLimitGroup = null;
+    }
+
+    /**
+     * Constructor for CreateResourceLimitGroupResponse
+     * @param resourceLimitGroup - The resource limit group to be created
+     */
+    public CreateResourceLimitGroupResponse(final ResourceLimitGroup resourceLimitGroup) {
+        this.resourceLimitGroup = resourceLimitGroup;
+    }
+
+    /**
+     * Constructor for CreateResourceLimitGroupResponse
+     * @param in - A {@link StreamInput} object
+     */
+    public CreateResourceLimitGroupResponse(StreamInput in) throws IOException {
+        resourceLimitGroup = new ResourceLimitGroup(in);
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        resourceLimitGroup.writeTo(out);
+    }
+
+    @Override
+    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
+        resourceLimitGroup.toXContent(builder, params);
+        return builder;
+    }
+
+    /**
+     * resourceLimitGroup getter
+     */
+    public ResourceLimitGroup getResourceLimitGroup() {
+        return resourceLimitGroup;
+    }
+
+    /**
+     * restStatus getter
+     */
+    public RestStatus getRestStatus() {
+        return restStatus;
+    }
+
+    /**
+     * restStatus setter
+     * @param restStatus - A {@link RestStatus} object
+     */
+    public void setRestStatus(RestStatus restStatus) {
+        this.restStatus = restStatus;
+    }
+}

plugins/query-resource-limit-group/src/main/java/org/opensearch/plugin/resource_limit_group/DeleteResourceLimitGroupAction.java

@@ -0,0 +1,37 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.plugin.resource_limit_group;
+
+import org.opensearch.action.ActionType;
+
+/**
+ * Rest action to delete Resource Limit Group
+ *
+ * @opensearch.api
+ */
+public class DeleteResourceLimitGroupAction extends ActionType<DeleteResourceLimitGroupResponse> {
+
+    /**
+    /**
+     * An instance of DeleteResourceLimitGroupAction
+     */
+    public static final DeleteResourceLimitGroupAction INSTANCE = new DeleteResourceLimitGroupAction();
+
+    /**
+     * Name for DeleteResourceLimitGroupAction
+     */
+    public static final String NAME = "cluster:admin/opensearch/resource_limit_group/_delete";
+
+    /**
+     * Default constructor
+     */
+    private DeleteResourceLimitGroupAction() {
+        super(NAME, DeleteResourceLimitGroupResponse::new);
+    }
+}