co.elastic.clients.elasticsearch.core.UpdateByQueryRethrottleRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.core;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
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 co.elastic.clients.util.ObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Long;
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;
// typedef: _global.update_by_query_rethrottle.Request
/**
* Changes the number of requests per second for a particular Update By Query
* operation.
*
* @see API
* specification
*/
public class UpdateByQueryRethrottleRequest extends RequestBase {
@Nullable
private final Long requestsPerSecond;
private final String taskId;
// ---------------------------------------------------------------------------------------------
private UpdateByQueryRethrottleRequest(Builder builder) {
this.requestsPerSecond = builder.requestsPerSecond;
this.taskId = ApiTypeHelper.requireNonNull(builder.taskId, this, "taskId");
}
public static UpdateByQueryRethrottleRequest of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The throttle to set on this request in floating sub-requests per second. -1
* means set no throttle.
*
* API name: {@code requests_per_second}
*/
@Nullable
public final Long requestsPerSecond() {
return this.requestsPerSecond;
}
/**
* Required - The task id to rethrottle
*
* API name: {@code task_id}
*/
public final String taskId() {
return this.taskId;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link UpdateByQueryRethrottleRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Long requestsPerSecond;
private String taskId;
/**
* The throttle to set on this request in floating sub-requests per second. -1
* means set no throttle.
*
* API name: {@code requests_per_second}
*/
public final Builder requestsPerSecond(@Nullable Long value) {
this.requestsPerSecond = value;
return this;
}
/**
* Required - The task id to rethrottle
*
* API name: {@code task_id}
*/
public final Builder taskId(String value) {
this.taskId = value;
return this;
}
/**
* Builds a {@link UpdateByQueryRethrottleRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public UpdateByQueryRethrottleRequest build() {
_checkSingleUse();
return new UpdateByQueryRethrottleRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code update_by_query_rethrottle}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/update_by_query_rethrottle",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _taskId = 1 << 0;
int propsSet = 0;
propsSet |= _taskId;
if (propsSet == (_taskId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_update_by_query");
buf.append("/");
SimpleEndpoint.pathEncode(request.taskId, buf);
buf.append("/_rethrottle");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.requestsPerSecond != null) {
params.put("requests_per_second", String.valueOf(request.requestsPerSecond));
}
return params;
}, SimpleEndpoint.emptyMap(), false, UpdateByQueryRethrottleResponse._DESERIALIZER);
}