Package co.elastic.clients.elasticsearch.graph

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExploreRequest	build()	Builds a ExploreRequest.
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	connections(Function<Hop.Builder,ObjectBuilder<Hop>> fn)	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	controls(Function<ExploreControls.Builder,ObjectBuilder<ExploreControls>> fn)	Direct the Graph API how to build the graph.
final ExploreRequest.Builder	index(String value, String... values)	Required - Name of the index.
final ExploreRequest.Builder	index(List<String> list)	Required - Name of the index.
final ExploreRequest.Builder	query(Query value)	A seed query that identifies the documents of interest.
final ExploreRequest.Builder	query(QueryVariant value)	A seed query that identifies the documents of interest.
final ExploreRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	A seed query that identifies the documents of interest.
final ExploreRequest.Builder	routing(String value)	Custom value used to route operations to a specific shard.
protected ExploreRequest.Builder	self()
final ExploreRequest.Builder	timeout(Time value)	Specifies the period of time to wait for a response from each shard.
final ExploreRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	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	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.
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

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

connections

public final ExploreRequest.Builder connections(@Nullable
 Hop value)

Specifies or more fields from which you want to extract terms that are associated with the specified vertices.

API name: connections

connections

public final ExploreRequest.Builder connections(Function<Hop.Builder,ObjectBuilder<Hop>> fn)

Specifies or more fields from which you want to extract terms that are associated with the specified vertices.

API name: connections

controls

public final ExploreRequest.Builder controls(@Nullable
 ExploreControls value)

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

public final ExploreRequest.Builder index(List<String> list)

Required - Name of the index.

API name: index

Adds all elements of list to index.

index

public final ExploreRequest.Builder index(String value,
 String... values)

Required - Name of the index.

API name: index

Adds one or more values to index.

query

public final ExploreRequest.Builder query(@Nullable
 Query value)

A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.

API name: query

query

public final ExploreRequest.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.

API name: query

query

public final ExploreRequest.Builder query(QueryVariant value)

A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.

API name: query

routing

public final ExploreRequest.Builder routing(@Nullable
 String value)

Custom value used to route operations to a specific shard.

API name: routing

timeout

public final ExploreRequest.Builder timeout(@Nullable
 Time value)

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

public final ExploreRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

public 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.

API name: vertices

Adds all elements of list to vertices.

vertices

public 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.

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

protected ExploreRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExploreRequest.Builder>

build

public ExploreRequest build()

Builds a ExploreRequest.

Specified by:

build in interface ObjectBuilder<ExploreRequest>

Throws:

NullPointerException - if some of the required fields are null.