co.elastic.clients.elasticsearch.watcher.ExecuteWatchRequest Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. 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 co.elastic.clients.elasticsearch.watcher;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.json.JsonData;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: watcher.execute_watch.Request
/**
* Run a watch. This API can be used to force execution of the watch outside of
* its triggering logic or to simulate the watch execution for debugging
* purposes.
*
* For testing and debugging purposes, you also have fine-grained control on how
* the watch runs. You can run the watch without running all of its actions or
* alternatively by simulating them. You can also force execution by ignoring
* the watch condition and control whether a watch record would be written to
* the watch history after it runs.
*
* You can use the run watch API to run watches that are not yet registered by
* specifying the watch definition inline. This serves as great tool for testing
* and debugging your watches prior to adding them to Watcher.
*
* When Elasticsearch security features are enabled on your cluster, watches are
* run with the privileges of the user that stored the watches. If your user is
* allowed to read index a, but not index b, then the
* exact same set of rules will apply during execution of a watch.
*
* When using the run watch API, the authorization data of the user that called
* the API will be used as a base, instead of the information who stored the
* watch. Refer to the external documentation for examples of watch execution
* requests, including existing, customized, and inline watches.
*
* @see API
* specification
*/
@JsonpDeserializable
public class ExecuteWatchRequest extends RequestBase implements JsonpSerializable {
private final Map actionModes;
private final Map alternativeInput;
@Nullable
private final Boolean debug;
@Nullable
private final String id;
@Nullable
private final Boolean ignoreCondition;
@Nullable
private final Boolean recordExecution;
@Nullable
private final SimulatedActions simulatedActions;
@Nullable
private final ScheduleTriggerEvent triggerData;
@Nullable
private final Watch watch;
// ---------------------------------------------------------------------------------------------
private ExecuteWatchRequest(Builder builder) {
this.actionModes = ApiTypeHelper.unmodifiable(builder.actionModes);
this.alternativeInput = ApiTypeHelper.unmodifiable(builder.alternativeInput);
this.debug = builder.debug;
this.id = builder.id;
this.ignoreCondition = builder.ignoreCondition;
this.recordExecution = builder.recordExecution;
this.simulatedActions = builder.simulatedActions;
this.triggerData = builder.triggerData;
this.watch = builder.watch;
}
public static ExecuteWatchRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Determines how to handle the watch actions as part of the watch execution.
*
* API name: {@code action_modes}
*/
public final Map actionModes() {
return this.actionModes;
}
/**
* When present, the watch uses this object as a payload instead of executing
* its own input.
*
* API name: {@code alternative_input}
*/
public final Map alternativeInput() {
return this.alternativeInput;
}
/**
* Defines whether the watch runs in debug mode.
*
* API name: {@code debug}
*/
@Nullable
public final Boolean debug() {
return this.debug;
}
/**
* The watch identifier.
*
* API name: {@code id}
*/
@Nullable
public final String id() {
return this.id;
}
/**
* When set to true, the watch execution uses the always condition.
* This can also be specified as an HTTP parameter.
*
* API name: {@code ignore_condition}
*/
@Nullable
public final Boolean ignoreCondition() {
return this.ignoreCondition;
}
/**
* When set to true, the watch record representing the watch
* execution result is persisted to the .watcher-history index for
* the current time. In addition, the status of the watch is updated, possibly
* throttling subsequent runs. This can also be specified as an HTTP parameter.
*
* API name: {@code record_execution}
*/
@Nullable
public final Boolean recordExecution() {
return this.recordExecution;
}
/**
* API name: {@code simulated_actions}
*/
@Nullable
public final SimulatedActions simulatedActions() {
return this.simulatedActions;
}
/**
* This structure is parsed as the data of the trigger event that will be used
* during the watch execution.
*
* API name: {@code trigger_data}
*/
@Nullable
public final ScheduleTriggerEvent triggerData() {
return this.triggerData;
}
/**
* When present, this watch is used instead of the one specified in the request.
* This watch is not persisted to the index and record_execution
* cannot be set.
*
* API name: {@code watch}
*/
@Nullable
public final Watch watch() {
return this.watch;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (ApiTypeHelper.isDefined(this.actionModes)) {
generator.writeKey("action_modes");
generator.writeStartObject();
for (Map.Entry item0 : this.actionModes.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.alternativeInput)) {
generator.writeKey("alternative_input");
generator.writeStartObject();
for (Map.Entry item0 : this.alternativeInput.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.ignoreCondition != null) {
generator.writeKey("ignore_condition");
generator.write(this.ignoreCondition);
}
if (this.recordExecution != null) {
generator.writeKey("record_execution");
generator.write(this.recordExecution);
}
if (this.simulatedActions != null) {
generator.writeKey("simulated_actions");
this.simulatedActions.serialize(generator, mapper);
}
if (this.triggerData != null) {
generator.writeKey("trigger_data");
this.triggerData.serialize(generator, mapper);
}
if (this.watch != null) {
generator.writeKey("watch");
this.watch.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ExecuteWatchRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Map actionModes;
@Nullable
private Map alternativeInput;
@Nullable
private Boolean debug;
@Nullable
private String id;
@Nullable
private Boolean ignoreCondition;
@Nullable
private Boolean recordExecution;
@Nullable
private SimulatedActions simulatedActions;
@Nullable
private ScheduleTriggerEvent triggerData;
@Nullable
private Watch watch;
/**
* Determines how to handle the watch actions as part of the watch execution.
*
* API name: {@code action_modes}
*
* Adds all entries of map to actionModes.
*/
public final Builder actionModes(Map map) {
this.actionModes = _mapPutAll(this.actionModes, map);
return this;
}
/**
* Determines how to handle the watch actions as part of the watch execution.
*
* API name: {@code action_modes}
*
* Adds an entry to actionModes.
*/
public final Builder actionModes(String key, ActionExecutionMode value) {
this.actionModes = _mapPut(this.actionModes, key, value);
return this;
}
/**
* When present, the watch uses this object as a payload instead of executing
* its own input.
*
* API name: {@code alternative_input}
*
* Adds all entries of map to alternativeInput.
*/
public final Builder alternativeInput(Map map) {
this.alternativeInput = _mapPutAll(this.alternativeInput, map);
return this;
}
/**
* When present, the watch uses this object as a payload instead of executing
* its own input.
*
* API name: {@code alternative_input}
*
* Adds an entry to alternativeInput.
*/
public final Builder alternativeInput(String key, JsonData value) {
this.alternativeInput = _mapPut(this.alternativeInput, key, value);
return this;
}
/**
* Defines whether the watch runs in debug mode.
*
* API name: {@code debug}
*/
public final Builder debug(@Nullable Boolean value) {
this.debug = value;
return this;
}
/**
* The watch identifier.
*
* API name: {@code id}
*/
public final Builder id(@Nullable String value) {
this.id = value;
return this;
}
/**
* When set to true, the watch execution uses the always condition.
* This can also be specified as an HTTP parameter.
*
* API name: {@code ignore_condition}
*/
public final Builder ignoreCondition(@Nullable Boolean value) {
this.ignoreCondition = value;
return this;
}
/**
* When set to true, the watch record representing the watch
* execution result is persisted to the .watcher-history index for
* the current time. In addition, the status of the watch is updated, possibly
* throttling subsequent runs. This can also be specified as an HTTP parameter.
*
* API name: {@code record_execution}
*/
public final Builder recordExecution(@Nullable Boolean value) {
this.recordExecution = value;
return this;
}
/**
* API name: {@code simulated_actions}
*/
public final Builder simulatedActions(@Nullable SimulatedActions value) {
this.simulatedActions = value;
return this;
}
/**
* API name: {@code simulated_actions}
*/
public final Builder simulatedActions(Function> fn) {
return this.simulatedActions(fn.apply(new SimulatedActions.Builder()).build());
}
/**
* This structure is parsed as the data of the trigger event that will be used
* during the watch execution.
*
* API name: {@code trigger_data}
*/
public final Builder triggerData(@Nullable ScheduleTriggerEvent value) {
this.triggerData = value;
return this;
}
/**
* This structure is parsed as the data of the trigger event that will be used
* during the watch execution.
*
* API name: {@code trigger_data}
*/
public final Builder triggerData(
Function> fn) {
return this.triggerData(fn.apply(new ScheduleTriggerEvent.Builder()).build());
}
/**
* When present, this watch is used instead of the one specified in the request.
* This watch is not persisted to the index and record_execution
* cannot be set.
*
* API name: {@code watch}
*/
public final Builder watch(@Nullable Watch value) {
this.watch = value;
return this;
}
/**
* When present, this watch is used instead of the one specified in the request.
* This watch is not persisted to the index and record_execution
* cannot be set.
*
* API name: {@code watch}
*/
public final Builder watch(Function> fn) {
return this.watch(fn.apply(new Watch.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ExecuteWatchRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ExecuteWatchRequest build() {
_checkSingleUse();
return new ExecuteWatchRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ExecuteWatchRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, ExecuteWatchRequest::setupExecuteWatchRequestDeserializer);
protected static void setupExecuteWatchRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::actionModes, JsonpDeserializer.stringMapDeserializer(ActionExecutionMode._DESERIALIZER),
"action_modes");
op.add(Builder::alternativeInput, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER),
"alternative_input");
op.add(Builder::ignoreCondition, JsonpDeserializer.booleanDeserializer(), "ignore_condition");
op.add(Builder::recordExecution, JsonpDeserializer.booleanDeserializer(), "record_execution");
op.add(Builder::simulatedActions, SimulatedActions._DESERIALIZER, "simulated_actions");
op.add(Builder::triggerData, ScheduleTriggerEvent._DESERIALIZER, "trigger_data");
op.add(Builder::watch, Watch._DESERIALIZER, "watch");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code watcher.execute_watch}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/watcher.execute_watch",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _id = 1 << 0;
int propsSet = 0;
if (request.id() != null)
propsSet |= _id;
if (propsSet == (_id)) {
StringBuilder buf = new StringBuilder();
buf.append("/_watcher");
buf.append("/watch");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
buf.append("/_execute");
return buf.toString();
}
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_watcher");
buf.append("/watch");
buf.append("/_execute");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _id = 1 << 0;
int propsSet = 0;
if (request.id() != null)
propsSet |= _id;
if (propsSet == (_id)) {
params.put("id", request.id);
}
if (propsSet == 0) {
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.debug != null) {
params.put("debug", String.valueOf(request.debug));
}
return params;
}, SimpleEndpoint.emptyMap(), true, ExecuteWatchResponse._DESERIALIZER);
}