co.elastic.clients.elasticsearch.cluster.ExistsComponentTemplateRequest 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.cluster;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
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.BooleanEndpoint;
import co.elastic.clients.transport.endpoints.BooleanResponse;
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.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
// typedef: cluster.exists_component_template.Request
/**
* Returns information about whether a particular component template exist
*
* @see API
* specification
*/
public class ExistsComponentTemplateRequest extends RequestBase {
@Nullable
private final Boolean local;
@Nullable
private final Time masterTimeout;
private final List name;
// ---------------------------------------------------------------------------------------------
private ExistsComponentTemplateRequest(Builder builder) {
this.local = builder.local;
this.masterTimeout = builder.masterTimeout;
this.name = ApiTypeHelper.unmodifiableRequired(builder.name, this, "name");
}
public static ExistsComponentTemplateRequest of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If true, the request retrieves information from the local node only. Defaults
* to false, which means information is retrieved from the master node.
*
* API name: {@code local}
*/
@Nullable
public final Boolean local() {
return this.local;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* Required - Comma-separated list of component template names used to limit the
* request. Wildcard (*) expressions are supported.
*
* API name: {@code name}
*/
public final List name() {
return this.name;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ExistsComponentTemplateRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Boolean local;
@Nullable
private Time masterTimeout;
private List name;
/**
* If true, the request retrieves information from the local node only. Defaults
* to false, which means information is retrieved from the master node.
*
* API name: {@code local}
*/
public final Builder local(@Nullable Boolean value) {
this.local = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(@Nullable Time value) {
this.masterTimeout = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* Required - Comma-separated list of component template names used to limit the
* request. Wildcard (*) expressions are supported.
*
* API name: {@code name}
*
* Adds all elements of list to name.
*/
public final Builder name(List list) {
this.name = _listAddAll(this.name, list);
return this;
}
/**
* Required - Comma-separated list of component template names used to limit the
* request. Wildcard (*) expressions are supported.
*
* API name: {@code name}
*
* Adds one or more values to name.
*/
public final Builder name(String value, String... values) {
this.name = _listAdd(this.name, value, values);
return this;
}
/**
* Builds a {@link ExistsComponentTemplateRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ExistsComponentTemplateRequest build() {
_checkSingleUse();
return new ExistsComponentTemplateRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code cluster.exists_component_template}".
*/
public static final Endpoint _ENDPOINT = new BooleanEndpoint<>(
"es/cluster.exists_component_template",
// Request method
request -> {
return "HEAD";
},
// Request path
request -> {
final int _name = 1 << 0;
int propsSet = 0;
propsSet |= _name;
if (propsSet == (_name)) {
StringBuilder buf = new StringBuilder();
buf.append("/_component_template");
buf.append("/");
SimpleEndpoint.pathEncode(request.name.stream().map(v -> v).collect(Collectors.joining(",")), buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (request.local != null) {
params.put("local", String.valueOf(request.local));
}
return params;
}, SimpleEndpoint.emptyMap(), false, null);
}