Class ExploreRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExploreRequest.Builder>
co.elastic.clients.elasticsearch.graph.ExploreRequest.Builder
- All Implemented Interfaces:
WithJson<ExploreRequest.Builder>
,ObjectBuilder<ExploreRequest>
- Enclosing class:
- ExploreRequest
public static class ExploreRequest.Builder
extends RequestBase.AbstractBuilder<ExploreRequest.Builder>
implements ObjectBuilder<ExploreRequest>
Builder for
ExploreRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aExploreRequest
.final ExploreRequest.Builder
connections
(Hop value) Specifies or more fields from which you want to extract terms that are associated with the specified vertices.final ExploreRequest.Builder
Specifies or more fields from which you want to extract terms that are associated with the specified vertices.final ExploreRequest.Builder
controls
(ExploreControls value) Direct the Graph API how to build the graph.final ExploreRequest.Builder
Direct the Graph API how to build the graph.final ExploreRequest.Builder
Required - Name of the index.final ExploreRequest.Builder
Required - Name of the index.final ExploreRequest.Builder
A seed query that identifies the documents of interest.final ExploreRequest.Builder
A seed query that identifies the documents of interest.final ExploreRequest.Builder
Custom value used to route operations to a specific shard.protected ExploreRequest.Builder
self()
final ExploreRequest.Builder
Specifies the period of time to wait for a response from each shard.final ExploreRequest.Builder
Specifies the period of time to wait for a response from each shard.final ExploreRequest.Builder
vertices
(VertexDefinition value, VertexDefinition... values) Specifies one or more fields that contain the terms you want to include in the graph as vertices.final ExploreRequest.Builder
Specifies one or more fields that contain the terms you want to include in the graph as vertices.final ExploreRequest.Builder
vertices
(List<VertexDefinition> list) Specifies one or more fields that contain the terms you want to include in the graph as vertices.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
-
connections
Specifies or more fields from which you want to extract terms that are associated with the specified vertices.API name:
connections
-
connections
Specifies or more fields from which you want to extract terms that are associated with the specified vertices.API name:
connections
-
controls
Direct the Graph API how to build the graph.API name:
controls
-
controls
public final ExploreRequest.Builder controls(Function<ExploreControls.Builder, ObjectBuilder<ExploreControls>> fn) Direct the Graph API how to build the graph.API name:
controls
-
index
Required - Name of the index.API name:
index
Adds all elements of
list
toindex
. -
index
Required - Name of the index.API name:
index
Adds one or more values to
index
. -
query
A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.API name:
query
-
query
A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.API name:
query
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
timeout
Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.API name:
timeout
-
timeout
Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.API name:
timeout
-
vertices
Specifies one or more fields that contain the terms you want to include in the graph as vertices.API name:
vertices
Adds all elements of
list
tovertices
. -
vertices
Specifies one or more fields that contain the terms you want to include in the graph as vertices.API name:
vertices
Adds one or more values to
vertices
. -
vertices
public final ExploreRequest.Builder vertices(Function<VertexDefinition.Builder, ObjectBuilder<VertexDefinition>> fn) Specifies one or more fields that contain the terms you want to include in the graph as vertices.API name:
vertices
Adds a value to
vertices
using a builder lambda. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ExploreRequest.Builder>
-
build
Builds aExploreRequest
.- Specified by:
build
in interfaceObjectBuilder<ExploreRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-