Deletepit API #3
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| /* | ||
| * 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.action.search; | ||
|
|
||
| import org.opensearch.action.ActionType; | ||
|
|
||
| public class DeletePITAction extends ActionType<DeletePITResponse> { | ||
|
|
||
| public static final DeletePITAction INSTANCE = new DeletePITAction(); | ||
| public static final String NAME = "indices:admin/delete/pit"; | ||
|
|
||
| private DeletePITAction() { | ||
| super(NAME, DeletePITResponse::new); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| /* | ||
| * 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.action.search; | ||
|
|
||
| import org.opensearch.action.ActionRequest; | ||
| import org.opensearch.action.ActionRequestValidationException; | ||
| import org.opensearch.common.io.stream.StreamInput; | ||
| import org.opensearch.common.io.stream.StreamOutput; | ||
| import org.opensearch.common.xcontent.ToXContent; | ||
| import org.opensearch.common.xcontent.ToXContentObject; | ||
| import org.opensearch.common.xcontent.XContentBuilder; | ||
| import org.opensearch.common.xcontent.XContentParser; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
|
|
||
| import static org.opensearch.action.ValidateActions.addValidationError; | ||
|
|
||
| /** | ||
| * Request to delete one or more PIT contexts based on IDs. | ||
| */ | ||
| public class DeletePITRequest extends ActionRequest implements ToXContentObject { | ||
|
|
||
| /** | ||
| * List of PIT IDs to be deleted , and use "_all" to delete all PIT reader contexts | ||
| */ | ||
| private List<String> pitIds; | ||
|
|
||
| public DeletePITRequest(StreamInput in) throws IOException { | ||
| super(in); | ||
| pitIds = Arrays.asList(in.readStringArray()); | ||
| } | ||
|
|
||
| public DeletePITRequest(String... pitIds) { | ||
| if (pitIds != null) { | ||
| this.pitIds = Arrays.asList(pitIds); | ||
| } | ||
| } | ||
|
|
||
| public DeletePITRequest(List<String> pitIds) { | ||
| if (pitIds != null) { | ||
| this.pitIds = pitIds; | ||
| } | ||
| } | ||
|
|
||
| public DeletePITRequest() {} | ||
|
|
||
| public List<String> getPitIds() { | ||
| return pitIds; | ||
| } | ||
|
|
||
| public void setPitIds(List<String> pitIds) { | ||
| this.pitIds = pitIds; | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| ActionRequestValidationException validationException = null; | ||
| if (pitIds == null || pitIds.isEmpty()) { | ||
| validationException = addValidationError("no pit ids specified", validationException); | ||
| } | ||
| return validationException; | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| super.writeTo(out); | ||
| if (pitIds == null) { | ||
| out.writeVInt(0); | ||
| } else { | ||
| out.writeStringArray(pitIds.toArray(new String[pitIds.size()])); | ||
| } | ||
| } | ||
|
|
||
| public void addPitId(String pitId) { | ||
| if (pitIds == null) { | ||
| pitIds = new ArrayList<>(); | ||
| } | ||
| pitIds.add(pitId); | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.startArray("pit_id"); | ||
| for (String pitId : pitIds) { | ||
| builder.value(pitId); | ||
| } | ||
| builder.endArray(); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| public void fromXContent(XContentParser parser) throws IOException { | ||
| pitIds = null; | ||
| if (parser.nextToken() != XContentParser.Token.START_OBJECT) { | ||
| throw new IllegalArgumentException("Malformed content, must start with an object"); | ||
| } else { | ||
| XContentParser.Token token; | ||
| String currentFieldName = null; | ||
| while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) { | ||
| if (token == XContentParser.Token.FIELD_NAME) { | ||
| currentFieldName = parser.currentName(); | ||
| } else if ("pit_id".equals(currentFieldName)) { | ||
| if (token == XContentParser.Token.START_ARRAY) { | ||
| while ((token = parser.nextToken()) != XContentParser.Token.END_ARRAY) { | ||
| if (token.isValue() == false) { | ||
| throw new IllegalArgumentException("pit_id array element should only contain pit_id"); | ||
| } | ||
| addPitId(parser.text()); | ||
| } | ||
| } else { | ||
| if (token.isValue() == false) { | ||
| throw new IllegalArgumentException("pit_id element should only contain pit_id"); | ||
| } | ||
| addPitId(parser.text()); | ||
| } | ||
| } else { | ||
| throw new IllegalArgumentException( | ||
| "Unknown parameter [" + currentFieldName + "] in request body or parameter is of the wrong type[" + token + "] " | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * 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.action.search; | ||
|
|
||
| import org.opensearch.action.ActionResponse; | ||
| import org.opensearch.common.ParseField; | ||
| import org.opensearch.common.io.stream.StreamInput; | ||
| import org.opensearch.common.io.stream.StreamOutput; | ||
| import org.opensearch.common.xcontent.ConstructingObjectParser; | ||
| import org.opensearch.common.xcontent.ObjectParser; | ||
| import org.opensearch.common.xcontent.StatusToXContentObject; | ||
| import org.opensearch.common.xcontent.ToXContent; | ||
| import org.opensearch.common.xcontent.XContentBuilder; | ||
| import org.opensearch.common.xcontent.XContentParser; | ||
| import org.opensearch.rest.RestStatus; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; | ||
| import static org.opensearch.rest.RestStatus.NOT_FOUND; | ||
| import static org.opensearch.rest.RestStatus.OK; | ||
|
|
||
| public class DeletePITResponse extends ActionResponse implements StatusToXContentObject { | ||
|
|
||
| /** | ||
| * This will be true if all PIT reader contexts are deleted. | ||
| */ | ||
| private final boolean succeeded; | ||
|
|
||
| public DeletePITResponse(boolean succeeded) { | ||
| this.succeeded = succeeded; | ||
| } | ||
|
|
||
| public DeletePITResponse(StreamInput in) throws IOException { | ||
| super(in); | ||
| succeeded = in.readBoolean(); | ||
| } | ||
|
|
||
| /** | ||
| * @return Whether the attempt to delete PIT was successful. | ||
| */ | ||
| public boolean isSucceeded() { | ||
| return succeeded; | ||
| } | ||
|
|
||
| @Override | ||
| public RestStatus status() { | ||
| return succeeded ? OK : NOT_FOUND; | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| out.writeBoolean(succeeded); | ||
| } | ||
|
|
||
| private static final ParseField SUCCEEDED = new ParseField("succeeded"); | ||
|
|
||
| private static final ConstructingObjectParser<DeletePITResponse, Void> PARSER = new ConstructingObjectParser<>( | ||
| "delete_pit", | ||
| true, | ||
| a -> new DeletePITResponse((boolean) a[0]) | ||
| ); | ||
| static { | ||
| PARSER.declareField(constructorArg(), (parser, context) -> parser.booleanValue(), SUCCEEDED, ObjectParser.ValueType.BOOLEAN); | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.field(SUCCEEDED.getPreferredName(), succeeded); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| /** | ||
| * Parse the delete PIT response body into a new {@link DeletePITResponse} object | ||
| */ | ||
| public static DeletePITResponse fromXContent(XContentParser parser) throws IOException { | ||
| return PARSER.apply(parser, null); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
variable name and action name should be consistent for delete all should be consistent with
public static final String FREE_CONTEXT_PIT_ACTION_NAME = "indices:data/read/search[free_context/pit]";