Package co.elastic.clients.elasticsearch.graph

Class VertexDefinition.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<VertexDefinition.Builder>

co.elastic.clients.elasticsearch.graph.VertexDefinition.Builder

All Implemented Interfaces:

WithJson<VertexDefinition.Builder>, ObjectBuilder<VertexDefinition>

Enclosing class:

VertexDefinition

public static class VertexDefinition.Builder
extends WithJsonObjectBuilderBase<VertexDefinition.Builder>
implements ObjectBuilder<VertexDefinition>

Builder for VertexDefinition.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VertexDefinition	build()	Builds a VertexDefinition.
final VertexDefinition.Builder	exclude(String value, String... values)	Prevents the specified terms from being included in the results.
final VertexDefinition.Builder	exclude(List<String> list)	Prevents the specified terms from being included in the results.
final VertexDefinition.Builder	field(String value)	Required - Identifies a field in the documents of interest.
final VertexDefinition.Builder	include(VertexInclude value, VertexInclude... values)	Identifies the terms of interest that form the starting points from which you want to spider out.
final VertexDefinition.Builder	include(Function<VertexInclude.Builder,ObjectBuilder<VertexInclude>> fn)	Identifies the terms of interest that form the starting points from which you want to spider out.
final VertexDefinition.Builder	include(List<VertexInclude> list)	Identifies the terms of interest that form the starting points from which you want to spider out.
final VertexDefinition.Builder	minDocCount(Long value)	Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
protected VertexDefinition.Builder	self()
final VertexDefinition.Builder	shardMinDocCount(Long value)	Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.
final VertexDefinition.Builder	size(Integer value)	Specifies the maximum number of vertex terms returned for each field.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

exclude

public final VertexDefinition.Builder exclude(List<String> list)

Prevents the specified terms from being included in the results.

API name: exclude

Adds all elements of list to exclude.

exclude

public final VertexDefinition.Builder exclude(String value,
 String... values)

Prevents the specified terms from being included in the results.

API name: exclude

Adds one or more values to exclude.

field

public final VertexDefinition.Builder field(String value)

Required - Identifies a field in the documents of interest.

API name: field

include

public final VertexDefinition.Builder include(List<VertexInclude> list)

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

API name: include

Adds all elements of list to include.

include

public final VertexDefinition.Builder include(VertexInclude value,
 VertexInclude... values)

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

API name: include

Adds one or more values to include.

include

public final VertexDefinition.Builder include(Function<VertexInclude.Builder,ObjectBuilder<VertexInclude>> fn)

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

API name: include

Adds a value to include using a builder lambda.

minDocCount

public final VertexDefinition.Builder minDocCount(@Nullable
 Long value)

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

public final VertexDefinition.Builder shardMinDocCount(@Nullable
 Long value)

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

public final VertexDefinition.Builder size(@Nullable
 Integer value)

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

API name: size

self

protected VertexDefinition.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<VertexDefinition.Builder>

build

public VertexDefinition build()

Builds a VertexDefinition.

Specified by:

build in interface ObjectBuilder<VertexDefinition>

Throws:

NullPointerException - if some of the required fields are null.