Package co.elastic.clients.elasticsearch.graph

Class VertexDefinition

java.lang.Object

co.elastic.clients.elasticsearch.graph.VertexDefinition

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class VertexDefinition
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexDefinition.Builder	Builder for VertexDefinition.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<VertexDefinition>	_DESERIALIZER	Json deserializer for VertexDefinition

Method Summary

Modifier and Type	Method	Description
final List<String>	exclude()	Prevents the specified terms from being included in the results.
final String	field()	Required - Identifies a field in the documents of interest.
final List<VertexInclude>	include()	Identifies the terms of interest that form the starting points from which you want to spider out.
final Long	minDocCount()	Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
static VertexDefinition	of(Function<VertexDefinition.Builder,ObjectBuilder<VertexDefinition>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupVertexDefinitionDeserializer(ObjectDeserializer<VertexDefinition.Builder> op)
final Long	shardMinDocCount()	Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.
final Integer	size()	Specifies the maximum number of vertex terms returned for each field.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<VertexDefinition> _DESERIALIZER

Json deserializer for VertexDefinition

Method Details

of

public static VertexDefinition of(Function<VertexDefinition.Builder,ObjectBuilder<VertexDefinition>> fn)

exclude

public final List<String> exclude()

Prevents the specified terms from being included in the results.

API name: exclude

field

public final String field()

Required - Identifies a field in the documents of interest.

API name: field

include

public final List<VertexInclude> include()

Identifies the terms of interest that form the starting points from which you want to spider out.

API name: include

minDocCount

@Nullable
public final Long minDocCount()

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: min_doc_count

shardMinDocCount

@Nullable
public final Long shardMinDocCount()

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: shard_min_doc_count

size

@Nullable
public final Integer size()

Specifies the maximum number of vertex terms returned for each field.

API name: size

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupVertexDefinitionDeserializer

protected static void setupVertexDefinitionDeserializer(ObjectDeserializer<VertexDefinition.Builder> op)