co.elastic.clients.elasticsearch.indices.MappingLimitSettingsTotalFields 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.
*/
package co.elastic.clients.elasticsearch.indices;
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.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Long;
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: indices._types.MappingLimitSettingsTotalFields
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class MappingLimitSettingsTotalFields implements JsonpSerializable {
@Nullable
private final Long limit;
@Nullable
private final Boolean ignoreDynamicBeyondLimit;
// ---------------------------------------------------------------------------------------------
private MappingLimitSettingsTotalFields(Builder builder) {
this.limit = builder.limit;
this.ignoreDynamicBeyondLimit = builder.ignoreDynamicBeyondLimit;
}
public static MappingLimitSettingsTotalFields of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The maximum number of fields in an index. Field and object mappings, as well
* as field aliases count towards this limit. The limit is in place to prevent
* mappings and searches from becoming too large. Higher values can lead to
* performance degradations and memory issues, especially in clusters with a
* high load or few resources.
*
* API name: {@code limit}
*/
@Nullable
public final Long limit() {
return this.limit;
}
/**
* This setting determines what happens when a dynamically mapped field would
* exceed the total fields limit. When set to false (the default), the index
* request of the document that tries to add a dynamic field to the mapping will
* fail with the message Limit of total fields [X] has been exceeded. When set
* to true, the index request will not fail. Instead, fields that would exceed
* the limit are not added to the mapping, similar to dynamic: false. The fields
* that were not added to the mapping will be added to the _ignored field.
*
* API name: {@code ignore_dynamic_beyond_limit}
*/
@Nullable
public final Boolean ignoreDynamicBeyondLimit() {
return this.ignoreDynamicBeyondLimit;
}
/**
* 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.limit != null) {
generator.writeKey("limit");
generator.write(this.limit);
}
if (this.ignoreDynamicBeyondLimit != null) {
generator.writeKey("ignore_dynamic_beyond_limit");
generator.write(this.ignoreDynamicBeyondLimit);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link MappingLimitSettingsTotalFields}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private Long limit;
@Nullable
private Boolean ignoreDynamicBeyondLimit;
/**
* The maximum number of fields in an index. Field and object mappings, as well
* as field aliases count towards this limit. The limit is in place to prevent
* mappings and searches from becoming too large. Higher values can lead to
* performance degradations and memory issues, especially in clusters with a
* high load or few resources.
*
* API name: {@code limit}
*/
public final Builder limit(@Nullable Long value) {
this.limit = value;
return this;
}
/**
* This setting determines what happens when a dynamically mapped field would
* exceed the total fields limit. When set to false (the default), the index
* request of the document that tries to add a dynamic field to the mapping will
* fail with the message Limit of total fields [X] has been exceeded. When set
* to true, the index request will not fail. Instead, fields that would exceed
* the limit are not added to the mapping, similar to dynamic: false. The fields
* that were not added to the mapping will be added to the _ignored field.
*
* API name: {@code ignore_dynamic_beyond_limit}
*/
public final Builder ignoreDynamicBeyondLimit(@Nullable Boolean value) {
this.ignoreDynamicBeyondLimit = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link MappingLimitSettingsTotalFields}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public MappingLimitSettingsTotalFields build() {
_checkSingleUse();
return new MappingLimitSettingsTotalFields(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link MappingLimitSettingsTotalFields}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, MappingLimitSettingsTotalFields::setupMappingLimitSettingsTotalFieldsDeserializer);
protected static void setupMappingLimitSettingsTotalFieldsDeserializer(
ObjectDeserializer op) {
op.add(Builder::limit, JsonpDeserializer.longDeserializer(), "limit");
op.add(Builder::ignoreDynamicBeyondLimit, JsonpDeserializer.booleanDeserializer(),
"ignore_dynamic_beyond_limit");
}
}