-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CloseIndexResponse to HLRC (#44349)
The CloseIndexResponse was improved in #39687; this commit exposes it in the HLRC.
- Loading branch information
Showing
17 changed files
with
761 additions
and
123 deletions.
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
113 changes: 113 additions & 0 deletions
113
client/rest-high-level/src/main/java/org/elasticsearch/client/indices/CloseIndexRequest.java
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,113 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.client.indices; | ||
|
|
||
| import org.elasticsearch.action.admin.indices.open.OpenIndexResponse; | ||
| import org.elasticsearch.action.support.ActiveShardCount; | ||
| import org.elasticsearch.action.support.IndicesOptions; | ||
| import org.elasticsearch.client.TimedRequest; | ||
| import org.elasticsearch.client.Validatable; | ||
| import org.elasticsearch.client.ValidationException; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * A request to close an index. | ||
| */ | ||
| public class CloseIndexRequest extends TimedRequest implements Validatable { | ||
|
|
||
| private String[] indices; | ||
| private IndicesOptions indicesOptions = IndicesOptions.strictExpandOpen(); | ||
| private ActiveShardCount waitForActiveShards = ActiveShardCount.DEFAULT; | ||
|
|
||
| /** | ||
| * Creates a new close index request | ||
| * | ||
| * @param indices the indices to close | ||
| */ | ||
| public CloseIndexRequest(String... indices) { | ||
| this.indices = indices; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the indices to close | ||
| */ | ||
| public String[] indices() { | ||
| return indices; | ||
| } | ||
|
|
||
| /** | ||
| * Specifies what type of requested indices to ignore and how to deal with wildcard expressions. | ||
| * For example indices that don't exist. | ||
| * | ||
| * @return the current behaviour when it comes to index names and wildcard indices expressions | ||
| */ | ||
| public IndicesOptions indicesOptions() { | ||
| return indicesOptions; | ||
| } | ||
|
|
||
| /** | ||
| * Specifies what type of requested indices to ignore and how to deal with wildcard expressions. | ||
| * For example indices that don't exist. | ||
| * | ||
| * @param indicesOptions the desired behaviour regarding indices to ignore and wildcard indices expressions | ||
| */ | ||
| public CloseIndexRequest indicesOptions(IndicesOptions indicesOptions) { | ||
| this.indicesOptions = indicesOptions; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the wait for active shard count or null if the default should be used | ||
| */ | ||
| public ActiveShardCount waitForActiveShards() { | ||
| return waitForActiveShards; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the number of shard copies that should be active for indices opening to return. | ||
| * Defaults to {@link ActiveShardCount#DEFAULT}, which will wait for one shard copy | ||
| * (the primary) to become active. Set this value to {@link ActiveShardCount#ALL} to | ||
| * wait for all shards (primary and all replicas) to be active before returning. | ||
| * Otherwise, use {@link ActiveShardCount#from(int)} to set this value to any | ||
| * non-negative integer, up to the number of copies per shard (number of replicas + 1), | ||
| * to wait for the desired amount of shard copies to become active before returning. | ||
| * Indices opening will only wait up until the timeout value for the number of shard copies | ||
| * to be active before returning. Check {@link OpenIndexResponse#isShardsAcknowledged()} to | ||
| * determine if the requisite shard copies were all started before returning or timing out. | ||
| * | ||
| * @param waitForActiveShards number of active shard copies to wait on | ||
| */ | ||
| public CloseIndexRequest waitForActiveShards(ActiveShardCount waitForActiveShards) { | ||
| this.waitForActiveShards = waitForActiveShards; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public Optional<ValidationException> validate() { | ||
| if (indices == null || indices.length == 0) { | ||
| ValidationException validationException = new ValidationException(); | ||
| validationException.addValidationError("index is missing"); | ||
| return Optional.of(validationException); | ||
| } else { | ||
| return Optional.empty(); | ||
| } | ||
| } | ||
| } |
213 changes: 213 additions & 0 deletions
213
...nt/rest-high-level/src/main/java/org/elasticsearch/client/indices/CloseIndexResponse.java
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,213 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.client.indices; | ||
|
|
||
| import org.elasticsearch.ElasticsearchException; | ||
| import org.elasticsearch.action.support.DefaultShardOperationFailedException; | ||
| import org.elasticsearch.action.support.master.ShardsAcknowledgedResponse; | ||
| import org.elasticsearch.common.Nullable; | ||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.common.xcontent.XContentParserUtils; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| import static java.util.Collections.emptyList; | ||
| import static java.util.Collections.unmodifiableList; | ||
| import static org.elasticsearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg; | ||
| import static org.elasticsearch.common.xcontent.ObjectParser.ValueType; | ||
|
|
||
| public class CloseIndexResponse extends ShardsAcknowledgedResponse { | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static final ConstructingObjectParser<CloseIndexResponse, Void> PARSER = new ConstructingObjectParser<>("close_index_response", | ||
| true, args -> { | ||
| boolean acknowledged = (boolean) args[0]; | ||
| boolean shardsAcknowledged = args[1] != null ? (boolean) args[1] : acknowledged; | ||
| List<CloseIndexResponse.IndexResult> indices = args[2] != null ? (List<CloseIndexResponse.IndexResult>) args[2] : emptyList(); | ||
| return new CloseIndexResponse(acknowledged, shardsAcknowledged, indices); | ||
| }); | ||
|
|
||
| static { | ||
| declareAcknowledgedField(PARSER); | ||
| PARSER.declareField(optionalConstructorArg(), (parser, context) -> parser.booleanValue(), SHARDS_ACKNOWLEDGED, ValueType.BOOLEAN); | ||
| PARSER.declareNamedObjects(optionalConstructorArg(), (p, c, name) -> IndexResult.fromXContent(p, name), new ParseField("indices")); | ||
| } | ||
|
|
||
| private final List<CloseIndexResponse.IndexResult> indices; | ||
|
|
||
| public CloseIndexResponse(final boolean acknowledged, final boolean shardsAcknowledged, final List<IndexResult> indices) { | ||
| super(acknowledged, shardsAcknowledged); | ||
| this.indices = unmodifiableList(Objects.requireNonNull(indices)); | ||
| } | ||
|
|
||
| public List<IndexResult> getIndices() { | ||
| return indices; | ||
| } | ||
|
|
||
| public static CloseIndexResponse fromXContent(final XContentParser parser) { | ||
| return PARSER.apply(parser, null); | ||
| } | ||
|
|
||
| public static class IndexResult { | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static final ConstructingObjectParser<IndexResult, String> PARSER = new ConstructingObjectParser<>("index_result", true, | ||
| (args, index) -> { | ||
| Exception exception = (Exception) args[1]; | ||
| if (exception != null) { | ||
| assert (boolean) args[0] == false; | ||
| return new IndexResult(index, exception); | ||
| } | ||
| ShardResult[] shardResults = args[2] != null ? ((List<ShardResult>) args[2]).toArray(new ShardResult[0]) : null; | ||
| if (shardResults != null) { | ||
| assert (boolean) args[0] == false; | ||
| return new IndexResult(index, shardResults); | ||
| } | ||
| assert (boolean) args[0]; | ||
| return new IndexResult(index); | ||
| }); | ||
| static { | ||
| PARSER.declareBoolean(optionalConstructorArg(), new ParseField("closed")); | ||
| PARSER.declareObject(optionalConstructorArg(), (p, c) -> { | ||
| XContentParserUtils.ensureExpectedToken(XContentParser.Token.START_OBJECT, p.currentToken(), p::getTokenLocation); | ||
| XContentParserUtils.ensureExpectedToken(XContentParser.Token.FIELD_NAME, p.nextToken(), p::getTokenLocation); | ||
| Exception e = ElasticsearchException.failureFromXContent(p); | ||
| XContentParserUtils.ensureExpectedToken(XContentParser.Token.END_OBJECT, p.nextToken(), p::getTokenLocation); | ||
| return e; | ||
| }, new ParseField("exception")); | ||
| PARSER.declareNamedObjects(optionalConstructorArg(), | ||
| (p, c, id) -> ShardResult.fromXContent(p, id), new ParseField("failedShards")); | ||
| } | ||
|
|
||
| private final String index; | ||
| private final @Nullable Exception exception; | ||
| private final @Nullable ShardResult[] shards; | ||
|
|
||
| IndexResult(final String index) { | ||
| this(index, null, null); | ||
| } | ||
|
|
||
| IndexResult(final String index, final Exception failure) { | ||
| this(index, Objects.requireNonNull(failure), null); | ||
| } | ||
|
|
||
| IndexResult(final String index, final ShardResult[] shards) { | ||
| this(index, null, Objects.requireNonNull(shards)); | ||
| } | ||
|
|
||
| private IndexResult(final String index, @Nullable final Exception exception, @Nullable final ShardResult[] shards) { | ||
| this.index = Objects.requireNonNull(index); | ||
| this.exception = exception; | ||
| this.shards = shards; | ||
| } | ||
|
|
||
| public String getIndex() { | ||
| return index; | ||
| } | ||
|
|
||
| public @Nullable Exception getException() { | ||
| return exception; | ||
| } | ||
|
|
||
| public @Nullable ShardResult[] getShards() { | ||
| return shards; | ||
| } | ||
|
|
||
| public boolean hasFailures() { | ||
| if (exception != null) { | ||
| return true; | ||
| } | ||
| if (shards != null) { | ||
| for (ShardResult shard : shards) { | ||
| if (shard.hasFailures()) { | ||
| return true; | ||
| } | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| static IndexResult fromXContent(final XContentParser parser, final String name) { | ||
| return PARSER.apply(parser, name); | ||
| } | ||
| } | ||
|
|
||
| public static class ShardResult { | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static final ConstructingObjectParser<ShardResult, String> PARSER = new ConstructingObjectParser<>("shard_result", true, | ||
| (arg, id) -> { | ||
| Failure[] failures = arg[0] != null ? ((List<Failure>) arg[0]).toArray(new Failure[0]) : new Failure[0]; | ||
| return new ShardResult(Integer.parseInt(id), failures); | ||
| }); | ||
|
|
||
| static { | ||
| PARSER.declareObjectArray(optionalConstructorArg(), (p, c) -> Failure.PARSER.apply(p, null), new ParseField("failures")); | ||
| } | ||
|
|
||
| private final int id; | ||
| private final Failure[] failures; | ||
|
|
||
| ShardResult(final int id, final Failure[] failures) { | ||
| this.id = id; | ||
| this.failures = failures; | ||
| } | ||
|
|
||
| public boolean hasFailures() { | ||
| return failures != null && failures.length > 0; | ||
| } | ||
|
|
||
| public int getId() { | ||
| return id; | ||
| } | ||
|
|
||
| public Failure[] getFailures() { | ||
| return failures; | ||
| } | ||
|
|
||
| static ShardResult fromXContent(final XContentParser parser, final String id) { | ||
| return PARSER.apply(parser, id); | ||
| } | ||
|
|
||
| public static class Failure extends DefaultShardOperationFailedException { | ||
|
|
||
| static final ConstructingObjectParser<Failure, Void> PARSER = new ConstructingObjectParser<>("failure", true, | ||
| arg -> new Failure((String) arg[0], (int) arg[1], (Throwable) arg[2], (String) arg[3])); | ||
|
|
||
| static { | ||
| declareFields(PARSER); | ||
| PARSER.declareStringOrNull(optionalConstructorArg(), new ParseField("node")); | ||
| } | ||
|
|
||
| private @Nullable String nodeId; | ||
|
|
||
| Failure(final String index, final int shardId, final Throwable reason, final String nodeId) { | ||
| super(index, shardId, reason); | ||
| this.nodeId = nodeId; | ||
| } | ||
|
|
||
| public String getNodeId() { | ||
| return nodeId; | ||
| } | ||
| } | ||
| } | ||
| } |
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.