HLRC: Add get watch API #35531
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,54 @@ | ||
| /* | ||
| * 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.watcher; | ||
|
|
||
| import org.elasticsearch.client.Validatable; | ||
| import org.elasticsearch.client.ValidationException; | ||
|
|
||
| /** | ||
| * The request to get the watch by name (id) | ||
| */ | ||
| public final class GetWatchRequest implements Validatable { | ||
|
|
||
| private final String id; | ||
|
|
||
| public GetWatchRequest(String watchId) { | ||
| validateId(watchId); | ||
| this.id = watchId; | ||
| } | ||
|
|
||
| private void validateId(String id) { | ||
| ValidationException exception = new ValidationException(); | ||
| if (id == null) { | ||
| exception.addValidationError("watch id is missing"); | ||
| } else if (PutWatchRequest.isValidId(id) == false) { | ||
| exception.addValidationError("watch id contains whitespace"); | ||
| } | ||
| if (exception.validationErrors().isEmpty() == false) { | ||
| throw exception; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return The name of the watch to retrieve | ||
| */ | ||
| public String getId() { | ||
| return id; | ||
| } | ||
| } |
This file contains hidden or 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,155 @@ | ||
| /* | ||
| * 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.watcher; | ||
|
|
||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.bytes.BytesReference; | ||
| import org.elasticsearch.common.lucene.uid.Versions; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.DeprecationHandler; | ||
| import org.elasticsearch.common.xcontent.NamedXContentRegistry; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.common.xcontent.XContentType; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| public class GetWatchResponse { | ||
| private final String id; | ||
| private final long version; | ||
| private final WatchStatus status; | ||
|
|
||
| private final BytesReference source; | ||
| private transient Map<String, Object> sourceAsMap; | ||
|
|
||
| /** | ||
| * Ctor for missing watch | ||
| */ | ||
| public GetWatchResponse(String id) { | ||
| this(id, Versions.NOT_FOUND, null, null); | ||
| } | ||
|
|
||
| public GetWatchResponse(String id, long version, WatchStatus status, BytesReference source) { | ||
| this.id = id; | ||
| this.version = version; | ||
| this.status = status; | ||
| this.source = source; | ||
| } | ||
|
|
||
| public String getId() { | ||
| return id; | ||
| } | ||
|
|
||
| public long getVersion() { | ||
| return version; | ||
| } | ||
|
|
||
| public boolean isFound() { | ||
| return version != Versions.NOT_FOUND; | ||
| } | ||
|
|
||
| public WatchStatus getStatus() { | ||
| return status; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the {@link XContentType} of the source | ||
| */ | ||
| public XContentType getContentType() { | ||
| return XContentType.JSON; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the serialized watch | ||
| */ | ||
| public BytesReference getSource() { | ||
| return source; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the source as a map | ||
| */ | ||
| public Map<String, Object> getSourceAsMap() throws IOException { | ||
| if (sourceAsMap == null && source != null) { | ||
|
There was a problem hiding this comment. A couple questions:
There was a problem hiding this comment. +1, I changed it to return |
||
| // EMPTY is safe here because we never use namedObject | ||
| try (InputStream stream = source.streamInput(); | ||
| XContentParser parser = XContentType.JSON.xContent().createParser(NamedXContentRegistry.EMPTY, | ||
| DeprecationHandler.THROW_UNSUPPORTED_OPERATION, stream)) { | ||
| sourceAsMap = parser.map(); | ||
| } | ||
| } | ||
| return sourceAsMap; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| GetWatchResponse that = (GetWatchResponse) o; | ||
| return version == that.version && | ||
| Objects.equals(id, that.id) && | ||
| Objects.equals(status, that.status) && | ||
| Objects.equals(source, that.source); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(id, status, source, version); | ||
| } | ||
|
|
||
| private static final ParseField ID_FIELD = new ParseField("_id"); | ||
| private static final ParseField FOUND_FIELD = new ParseField("found"); | ||
| private static final ParseField VERSION_FIELD = new ParseField("_version"); | ||
| private static final ParseField STATUS_FIELD = new ParseField("status"); | ||
| private static final ParseField WATCH_FIELD = new ParseField("watch"); | ||
|
|
||
| private static ConstructingObjectParser<GetWatchResponse, Void> PARSER = | ||
| new ConstructingObjectParser<>("get_watch_response", true, | ||
| a -> { | ||
| boolean isFound = (boolean) a[1]; | ||
| if (isFound) { | ||
| BytesReference source = (BytesReference) a[4]; | ||
| return new GetWatchResponse((String) a[0], (long) a[2], (WatchStatus) a[3], source); | ||
| } else { | ||
| return new GetWatchResponse((String) a[0]); | ||
| } | ||
| }); | ||
|
|
||
| static { | ||
| PARSER.declareString(ConstructingObjectParser.constructorArg(), ID_FIELD); | ||
| PARSER.declareBoolean(ConstructingObjectParser.constructorArg(), FOUND_FIELD); | ||
| PARSER.declareLong(ConstructingObjectParser.optionalConstructorArg(), VERSION_FIELD); | ||
| PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), | ||
| (parser, context) -> WatchStatus.parse(parser), STATUS_FIELD); | ||
| PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), | ||
| (parser, context) -> { | ||
| try (XContentBuilder builder = XContentBuilder.builder(parser.contentType().xContent())) { | ||
| builder.copyCurrentStructure(parser); | ||
| return BytesReference.bytes(builder); | ||
| } | ||
| }, WATCH_FIELD); | ||
| } | ||
|
|
||
| public static GetWatchResponse fromXContent(XContentParser parser) throws IOException { | ||
| return PARSER.parse(parser, null); | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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.
Small comment: it would be nice to add a comment to this constructor explaining that it is for a 'missing watch', as opposed to the one below.