co.elastic.clients.elasticsearch.graph.VertexDefinition 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.graph;
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.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Integer;
import java.lang.Long;
import java.lang.String;
import java.util.List;
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: graph._types.VertexDefinition
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class VertexDefinition implements JsonpSerializable {
private final List exclude;
private final String field;
private final List include;
@Nullable
private final Long minDocCount;
@Nullable
private final Long shardMinDocCount;
@Nullable
private final Integer size;
// ---------------------------------------------------------------------------------------------
private VertexDefinition(Builder builder) {
this.exclude = ApiTypeHelper.unmodifiable(builder.exclude);
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.include = ApiTypeHelper.unmodifiable(builder.include);
this.minDocCount = builder.minDocCount;
this.shardMinDocCount = builder.shardMinDocCount;
this.size = builder.size;
}
public static VertexDefinition of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Prevents the specified terms from being included in the results.
*
* API name: {@code exclude}
*/
public final List exclude() {
return this.exclude;
}
/**
* Required - Identifies a field in the documents of interest.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* Identifies the terms of interest that form the starting points from which you
* want to spider out.
*
* API name: {@code include}
*/
public final List include() {
return this.include;
}
/**
* Specifies how many documents must contain a pair of terms before it is
* considered to be a useful connection. This setting acts as a certainty
* threshold.
*
* API name: {@code min_doc_count}
*/
@Nullable
public final Long minDocCount() {
return this.minDocCount;
}
/**
* Controls how many documents on a particular shard have to contain a pair of
* terms before the connection is returned for global consideration.
*
* API name: {@code shard_min_doc_count}
*/
@Nullable
public final Long shardMinDocCount() {
return this.shardMinDocCount;
}
/**
* Specifies the maximum number of vertex terms returned for each field.
*
* API name: {@code size}
*/
@Nullable
public final Integer size() {
return this.size;
}
/**
* 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 (ApiTypeHelper.isDefined(this.exclude)) {
generator.writeKey("exclude");
generator.writeStartArray();
for (String item0 : this.exclude) {
generator.write(item0);
}
generator.writeEnd();
}
generator.writeKey("field");
generator.write(this.field);
if (ApiTypeHelper.isDefined(this.include)) {
generator.writeKey("include");
generator.writeStartArray();
for (VertexInclude item0 : this.include) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.minDocCount != null) {
generator.writeKey("min_doc_count");
generator.write(this.minDocCount);
}
if (this.shardMinDocCount != null) {
generator.writeKey("shard_min_doc_count");
generator.write(this.shardMinDocCount);
}
if (this.size != null) {
generator.writeKey("size");
generator.write(this.size);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link VertexDefinition}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private List exclude;
private String field;
@Nullable
private List include;
@Nullable
private Long minDocCount;
@Nullable
private Long shardMinDocCount;
@Nullable
private Integer size;
/**
* Prevents the specified terms from being included in the results.
*
* API name: {@code exclude}
*
* Adds all elements of list to exclude.
*/
public final Builder exclude(List list) {
this.exclude = _listAddAll(this.exclude, list);
return this;
}
/**
* Prevents the specified terms from being included in the results.
*
* API name: {@code exclude}
*
* Adds one or more values to exclude.
*/
public final Builder exclude(String value, String... values) {
this.exclude = _listAdd(this.exclude, value, values);
return this;
}
/**
* Required - Identifies a field in the documents of interest.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = value;
return this;
}
/**
* Identifies the terms of interest that form the starting points from which you
* want to spider out.
*
* API name: {@code include}
*
* Adds all elements of list to include.
*/
public final Builder include(List list) {
this.include = _listAddAll(this.include, list);
return this;
}
/**
* Identifies the terms of interest that form the starting points from which you
* want to spider out.
*
* API name: {@code include}
*
* Adds one or more values to include.
*/
public final Builder include(VertexInclude value, VertexInclude... values) {
this.include = _listAdd(this.include, value, values);
return this;
}
/**
* Identifies the terms of interest that form the starting points from which you
* want to spider out.
*
* API name: {@code include}
*
* Adds a value to include using a builder lambda.
*/
public final Builder include(Function> fn) {
return include(fn.apply(new VertexInclude.Builder()).build());
}
/**
* Specifies how many documents must contain a pair of terms before it is
* considered to be a useful connection. This setting acts as a certainty
* threshold.
*
* API name: {@code min_doc_count}
*/
public final Builder minDocCount(@Nullable Long value) {
this.minDocCount = value;
return this;
}
/**
* Controls how many documents on a particular shard have to contain a pair of
* terms before the connection is returned for global consideration.
*
* API name: {@code shard_min_doc_count}
*/
public final Builder shardMinDocCount(@Nullable Long value) {
this.shardMinDocCount = value;
return this;
}
/**
* Specifies the maximum number of vertex terms returned for each field.
*
* API name: {@code size}
*/
public final Builder size(@Nullable Integer value) {
this.size = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link VertexDefinition}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public VertexDefinition build() {
_checkSingleUse();
return new VertexDefinition(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link VertexDefinition}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
VertexDefinition::setupVertexDefinitionDeserializer);
protected static void setupVertexDefinitionDeserializer(ObjectDeserializer op) {
op.add(Builder::exclude, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"exclude");
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::include, JsonpDeserializer.arrayDeserializer(VertexInclude._DESERIALIZER), "include");
op.add(Builder::minDocCount, JsonpDeserializer.longDeserializer(), "min_doc_count");
op.add(Builder::shardMinDocCount, JsonpDeserializer.longDeserializer(), "shard_min_doc_count");
op.add(Builder::size, JsonpDeserializer.integerDeserializer(), "size");
}
}