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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aVertexDefinition
.final VertexDefinition.Builder
Prevents the specified terms from being included in the results.final VertexDefinition.Builder
Prevents the specified terms from being included in the results.final VertexDefinition.Builder
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
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
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
exclude
Prevents the specified terms from being included in the results.API name:
exclude
Adds all elements of
list
toexclude
. -
exclude
Prevents the specified terms from being included in the results.API name:
exclude
Adds one or more values to
exclude
. -
field
Required - Identifies a field in the documents of interest.API name:
field
-
include
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
toinclude
. -
include
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
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
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
Specifies the maximum number of vertex terms returned for each field.API name:
size
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<VertexDefinition.Builder>
-
build
Builds aVertexDefinition
.- Specified by:
build
in interfaceObjectBuilder<VertexDefinition>
- Throws:
NullPointerException
- if some of the required fields are null.
-