co.elastic.clients.elasticsearch.core.FieldCapsRequest 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.ExpandWildcard;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.mapping.RuntimeField;
import co.elastic.clients.elasticsearch._types.query_dsl.Query;
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 co.elastic.clients.util.WithJsonObjectBuilderBase;
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: _global.field_caps.Request
/**
* The field capabilities API returns the information about the capabilities of
* fields among multiple indices. The field capabilities API returns runtime
* fields like any other field. For example, a runtime field with a type of
* keyword is returned as any other field that belongs to the
* keyword family.
*
* @see API
* specification
*/
@JsonpDeserializable
public class FieldCapsRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean allowNoIndices;
private final List expandWildcards;
private final List fields;
@Nullable
private final String filters;
@Nullable
private final Boolean ignoreUnavailable;
@Nullable
private final Boolean includeUnmapped;
private final List index;
@Nullable
private final Query indexFilter;
private final Map> runtimeMappings;
private final List types;
// ---------------------------------------------------------------------------------------------
private FieldCapsRequest(Builder builder) {
this.allowNoIndices = builder.allowNoIndices;
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
this.fields = ApiTypeHelper.unmodifiableRequired(builder.fields, this, "fields");
this.filters = builder.filters;
this.ignoreUnavailable = builder.ignoreUnavailable;
this.includeUnmapped = builder.includeUnmapped;
this.index = ApiTypeHelper.unmodifiable(builder.index);
this.indexFilter = builder.indexFilter;
this.runtimeMappings = ApiTypeHelper.unmodifiable(builder.runtimeMappings);
this.types = ApiTypeHelper.unmodifiable(builder.types);
}
public static FieldCapsRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If false, the request returns an error if any wildcard expression, index
* alias, or _all value targets only missing or closed indices.
* This behavior applies even if the request targets other open indices. For
* example, a request targeting foo*,bar* returns an error if an
* index starts with foo but no index starts with bar.
*
* API name: {@code allow_no_indices}
*/
@Nullable
public final Boolean allowNoIndices() {
return this.allowNoIndices;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*/
public final List expandWildcards() {
return this.expandWildcards;
}
/**
* Required - Comma-separated list of fields to retrieve capabilities for.
* Wildcard (*) expressions are supported.
*
* API name: {@code fields}
*/
public final List fields() {
return this.fields;
}
/**
* An optional set of filters: can include
* +metadata,-metadata,-nested,-multifield,-parent
*
* API name: {@code filters}
*/
@Nullable
public final String filters() {
return this.filters;
}
/**
* If true, missing or closed indices are not included in the
* response.
*
* API name: {@code ignore_unavailable}
*/
@Nullable
public final Boolean ignoreUnavailable() {
return this.ignoreUnavailable;
}
/**
* If true, unmapped fields are included in the response.
*
* API name: {@code include_unmapped}
*/
@Nullable
public final Boolean includeUnmapped() {
return this.includeUnmapped;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and indices, omit
* this parameter or use * or _all.
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* Allows to filter indices if the provided query rewrites to match_none on
* every shard.
*
* API name: {@code index_filter}
*/
@Nullable
public final Query indexFilter() {
return this.indexFilter;
}
/**
* Defines ad-hoc runtime fields in the request similar to the way it is done in
* search requests. These fields exist only as part of the query and take
* precedence over fields defined with the same name in the index mappings.
*
* API name: {@code runtime_mappings}
*/
public final Map> runtimeMappings() {
return this.runtimeMappings;
}
/**
* Only return results for fields that have one of the types in the list
*
* API name: {@code types}
*/
public final List types() {
return this.types;
}
/**
* 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 (this.indexFilter != null) {
generator.writeKey("index_filter");
this.indexFilter.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.runtimeMappings)) {
generator.writeKey("runtime_mappings");
generator.writeStartObject();
for (Map.Entry> item0 : this.runtimeMappings.entrySet()) {
generator.writeKey(item0.getKey());
generator.writeStartArray();
if (item0.getValue() != null) {
for (RuntimeField item1 : item0.getValue()) {
item1.serialize(generator, mapper);
}
}
generator.writeEnd();
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link FieldCapsRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private Boolean allowNoIndices;
@Nullable
private List expandWildcards;
private List fields;
@Nullable
private String filters;
@Nullable
private Boolean ignoreUnavailable;
@Nullable
private Boolean includeUnmapped;
@Nullable
private List index;
@Nullable
private Query indexFilter;
@Nullable
private Map> runtimeMappings;
@Nullable
private List types;
/**
* If false, the request returns an error if any wildcard expression, index
* alias, or _all value targets only missing or closed indices.
* This behavior applies even if the request targets other open indices. For
* example, a request targeting foo*,bar* returns an error if an
* index starts with foo but no index starts with bar.
*
* API name: {@code allow_no_indices}
*/
public final Builder allowNoIndices(@Nullable Boolean value) {
this.allowNoIndices = value;
return this;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*
* Adds all elements of list to expandWildcards.
*/
public final Builder expandWildcards(List list) {
this.expandWildcards = _listAddAll(this.expandWildcards, list);
return this;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*
* Adds one or more values to expandWildcards.
*/
public final Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) {
this.expandWildcards = _listAdd(this.expandWildcards, value, values);
return this;
}
/**
* Required - Comma-separated list of fields to retrieve capabilities for.
* Wildcard (*) expressions are supported.
*
* API name: {@code fields}
*
* Adds all elements of list to fields.
*/
public final Builder fields(List list) {
this.fields = _listAddAll(this.fields, list);
return this;
}
/**
* Required - Comma-separated list of fields to retrieve capabilities for.
* Wildcard (*) expressions are supported.
*
* API name: {@code fields}
*
* Adds one or more values to fields.
*/
public final Builder fields(String value, String... values) {
this.fields = _listAdd(this.fields, value, values);
return this;
}
/**
* An optional set of filters: can include
* +metadata,-metadata,-nested,-multifield,-parent
*
* API name: {@code filters}
*/
public final Builder filters(@Nullable String value) {
this.filters = value;
return this;
}
/**
* If true, missing or closed indices are not included in the
* response.
*
* API name: {@code ignore_unavailable}
*/
public final Builder ignoreUnavailable(@Nullable Boolean value) {
this.ignoreUnavailable = value;
return this;
}
/**
* If true, unmapped fields are included in the response.
*
* API name: {@code include_unmapped}
*/
public final Builder includeUnmapped(@Nullable Boolean value) {
this.includeUnmapped = value;
return this;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and indices, omit
* this parameter or use * or _all.
*
* API name: {@code index}
*
* Adds all elements of list to index.
*/
public final Builder index(List list) {
this.index = _listAddAll(this.index, list);
return this;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and indices, omit
* this parameter or use * or _all.
*
* API name: {@code index}
*
* Adds one or more values to index.
*/
public final Builder index(String value, String... values) {
this.index = _listAdd(this.index, value, values);
return this;
}
/**
* Allows to filter indices if the provided query rewrites to match_none on
* every shard.
*
* API name: {@code index_filter}
*/
public final Builder indexFilter(@Nullable Query value) {
this.indexFilter = value;
return this;
}
/**
* Allows to filter indices if the provided query rewrites to match_none on
* every shard.
*
* API name: {@code index_filter}
*/
public final Builder indexFilter(Function> fn) {
return this.indexFilter(fn.apply(new Query.Builder()).build());
}
/**
* Defines ad-hoc runtime fields in the request similar to the way it is done in
* search requests. These fields exist only as part of the query and take
* precedence over fields defined with the same name in the index mappings.
*
* API name: {@code runtime_mappings}
*
* Adds all entries of map to runtimeMappings.
*/
public final Builder runtimeMappings(Map> map) {
this.runtimeMappings = _mapPutAll(this.runtimeMappings, map);
return this;
}
/**
* Defines ad-hoc runtime fields in the request similar to the way it is done in
* search requests. These fields exist only as part of the query and take
* precedence over fields defined with the same name in the index mappings.
*
* API name: {@code runtime_mappings}
*
* Adds an entry to runtimeMappings.
*/
public final Builder runtimeMappings(String key, List value) {
this.runtimeMappings = _mapPut(this.runtimeMappings, key, value);
return this;
}
/**
* Only return results for fields that have one of the types in the list
*
* API name: {@code types}
*
* Adds all elements of list to types.
*/
public final Builder types(List list) {
this.types = _listAddAll(this.types, list);
return this;
}
/**
* Only return results for fields that have one of the types in the list
*
* API name: {@code types}
*
* Adds one or more values to types.
*/
public final Builder types(String value, String... values) {
this.types = _listAdd(this.types, value, values);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link FieldCapsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public FieldCapsRequest build() {
_checkSingleUse();
return new FieldCapsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link FieldCapsRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
FieldCapsRequest::setupFieldCapsRequestDeserializer);
protected static void setupFieldCapsRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::indexFilter, Query._DESERIALIZER, "index_filter");
op.add(Builder::runtimeMappings, JsonpDeserializer.stringMapDeserializer(
JsonpDeserializer.arrayDeserializer(RuntimeField._DESERIALIZER)), "runtime_mappings");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code field_caps}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/field_caps",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _index = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_field_caps");
return buf.toString();
}
if (propsSet == (_index)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
buf.append("/_field_caps");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (ApiTypeHelper.isDefined(request.types)) {
params.put("types", request.types.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (ApiTypeHelper.isDefined(request.expandWildcards)) {
params.put("expand_wildcards",
request.expandWildcards.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.ignoreUnavailable != null) {
params.put("ignore_unavailable", String.valueOf(request.ignoreUnavailable));
}
if (request.allowNoIndices != null) {
params.put("allow_no_indices", String.valueOf(request.allowNoIndices));
}
if (request.filters != null) {
params.put("filters", request.filters);
}
params.put("fields", request.fields.stream().map(v -> v).collect(Collectors.joining(",")));
if (request.includeUnmapped != null) {
params.put("include_unmapped", String.valueOf(request.includeUnmapped));
}
return params;
}, SimpleEndpoint.emptyMap(), true, FieldCapsResponse._DESERIALIZER);
}