co.elastic.clients.elasticsearch.core.DeleteRequest 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.Refresh;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.elasticsearch._types.VersionType;
import co.elastic.clients.elasticsearch._types.WaitForActiveShards;
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.delete.Request
/**
* Removes a document from the index.
*
* @see API
* specification
*/
public class DeleteRequest extends RequestBase {
private final String id;
@Nullable
private final Long ifPrimaryTerm;
@Nullable
private final Long ifSeqNo;
private final String index;
@Nullable
private final Refresh refresh;
@Nullable
private final String routing;
@Nullable
private final Time timeout;
@Nullable
private final Long version;
@Nullable
private final VersionType versionType;
@Nullable
private final WaitForActiveShards waitForActiveShards;
// ---------------------------------------------------------------------------------------------
private DeleteRequest(Builder builder) {
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.ifPrimaryTerm = builder.ifPrimaryTerm;
this.ifSeqNo = builder.ifSeqNo;
this.index = ApiTypeHelper.requireNonNull(builder.index, this, "index");
this.refresh = builder.refresh;
this.routing = builder.routing;
this.timeout = builder.timeout;
this.version = builder.version;
this.versionType = builder.versionType;
this.waitForActiveShards = builder.waitForActiveShards;
}
public static DeleteRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The document ID
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* only perform the delete operation if the last operation that has changed the
* document has the specified primary term
*
* API name: {@code if_primary_term}
*/
@Nullable
public final Long ifPrimaryTerm() {
return this.ifPrimaryTerm;
}
/**
* only perform the delete operation if the last operation that has changed the
* document has the specified sequence number
*
* API name: {@code if_seq_no}
*/
@Nullable
public final Long ifSeqNo() {
return this.ifSeqNo;
}
/**
* Required - The name of the index
*
* API name: {@code index}
*/
public final String index() {
return this.index;
}
/**
* If true then refresh the affected shards to make this operation
* visible to search, if wait_for then wait for a refresh to make
* this operation visible to search, if false (the default) then do
* nothing with refreshes.
*
* API name: {@code refresh}
*/
@Nullable
public final Refresh refresh() {
return this.refresh;
}
/**
* Specific routing value
*
* API name: {@code routing}
*/
@Nullable
public final String routing() {
return this.routing;
}
/**
* Explicit operation timeout
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* Explicit version number for concurrency control
*
* API name: {@code version}
*/
@Nullable
public final Long version() {
return this.version;
}
/**
* Specific version type
*
* API name: {@code version_type}
*/
@Nullable
public final VersionType versionType() {
return this.versionType;
}
/**
* Sets the number of shard copies that must be active before proceeding with
* the delete operation. Defaults to 1, meaning the primary shard only. Set to
* all for all shard copies, otherwise set to any non-negative
* value less than or equal to the total number of copies for the shard (number
* of replicas + 1)
*
* API name: {@code wait_for_active_shards}
*/
@Nullable
public final WaitForActiveShards waitForActiveShards() {
return this.waitForActiveShards;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DeleteRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
private String id;
@Nullable
private Long ifPrimaryTerm;
@Nullable
private Long ifSeqNo;
private String index;
@Nullable
private Refresh refresh;
@Nullable
private String routing;
@Nullable
private Time timeout;
@Nullable
private Long version;
@Nullable
private VersionType versionType;
@Nullable
private WaitForActiveShards waitForActiveShards;
/**
* Required - The document ID
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* only perform the delete operation if the last operation that has changed the
* document has the specified primary term
*
* API name: {@code if_primary_term}
*/
public final Builder ifPrimaryTerm(@Nullable Long value) {
this.ifPrimaryTerm = value;
return this;
}
/**
* only perform the delete operation if the last operation that has changed the
* document has the specified sequence number
*
* API name: {@code if_seq_no}
*/
public final Builder ifSeqNo(@Nullable Long value) {
this.ifSeqNo = value;
return this;
}
/**
* Required - The name of the index
*
* API name: {@code index}
*/
public final Builder index(String value) {
this.index = value;
return this;
}
/**
* If true then refresh the affected shards to make this operation
* visible to search, if wait_for then wait for a refresh to make
* this operation visible to search, if false (the default) then do
* nothing with refreshes.
*
* API name: {@code refresh}
*/
public final Builder refresh(@Nullable Refresh value) {
this.refresh = value;
return this;
}
/**
* Specific routing value
*
* API name: {@code routing}
*/
public final Builder routing(@Nullable String value) {
this.routing = value;
return this;
}
/**
* Explicit operation timeout
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Explicit operation timeout
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* Explicit version number for concurrency control
*
* API name: {@code version}
*/
public final Builder version(@Nullable Long value) {
this.version = value;
return this;
}
/**
* Specific version type
*
* API name: {@code version_type}
*/
public final Builder versionType(@Nullable VersionType value) {
this.versionType = value;
return this;
}
/**
* Sets the number of shard copies that must be active before proceeding with
* the delete operation. Defaults to 1, meaning the primary shard only. Set to
* all for all shard copies, otherwise set to any non-negative
* value less than or equal to the total number of copies for the shard (number
* of replicas + 1)
*
* API name: {@code wait_for_active_shards}
*/
public final Builder waitForActiveShards(@Nullable WaitForActiveShards value) {
this.waitForActiveShards = value;
return this;
}
/**
* Sets the number of shard copies that must be active before proceeding with
* the delete operation. Defaults to 1, meaning the primary shard only. Set to
* all for all shard copies, otherwise set to any non-negative
* value less than or equal to the total number of copies for the shard (number
* of replicas + 1)
*
* API name: {@code wait_for_active_shards}
*/
public final Builder waitForActiveShards(
Function> fn) {
return this.waitForActiveShards(fn.apply(new WaitForActiveShards.Builder()).build());
}
/**
* Builds a {@link DeleteRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DeleteRequest build() {
_checkSingleUse();
return new DeleteRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code delete}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/delete",
// Request method
request -> {
return "DELETE";
},
// Request path
request -> {
final int _index = 1 << 0;
final int _id = 1 << 1;
int propsSet = 0;
propsSet |= _index;
propsSet |= _id;
if (propsSet == (_index | _id)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index, buf);
buf.append("/_doc");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.routing != null) {
params.put("routing", request.routing);
}
if (request.versionType != null) {
params.put("version_type", request.versionType.jsonValue());
}
if (request.ifPrimaryTerm != null) {
params.put("if_primary_term", String.valueOf(request.ifPrimaryTerm));
}
if (request.ifSeqNo != null) {
params.put("if_seq_no", String.valueOf(request.ifSeqNo));
}
if (request.refresh != null) {
params.put("refresh", request.refresh.jsonValue());
}
if (request.waitForActiveShards != null) {
params.put("wait_for_active_shards", request.waitForActiveShards._toJsonString());
}
if (request.version != null) {
params.put("version", String.valueOf(request.version));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, DeleteResponse._DESERIALIZER);
}