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)	API name: connections
final ExploreRequest.Builder	connections(Function<Hop.Builder,ObjectBuilder<Hop>> fn)	API name: connections
final ExploreRequest.Builder	controls(ExploreControls value)	API name: controls
final ExploreRequest.Builder	controls(Function<ExploreControls.Builder,ObjectBuilder<ExploreControls>> fn)	API name: controls
final ExploreRequest.Builder	index(String value, String... values)	Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
final ExploreRequest.Builder	index(List<String> list)	Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
final ExploreRequest.Builder	query(Query value)	API name: query
final ExploreRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
final ExploreRequest.Builder	routing(String value)	Specific routing value
protected ExploreRequest.Builder	self()
final ExploreRequest.Builder	timeout(Time value)	Explicit operation timeout
final ExploreRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
final ExploreRequest.Builder	type(String value, String... values)	A comma-separated list of document types to search; leave empty to perform the operation on all types
final ExploreRequest.Builder	type(List<String> list)	A comma-separated list of document types to search; leave empty to perform the operation on all types
final ExploreRequest.Builder	vertices(VertexDefinition value, VertexDefinition... values)	API name: vertices
final ExploreRequest.Builder	vertices(Function<VertexDefinition.Builder,ObjectBuilder<VertexDefinition>> fn)	API name: vertices
final ExploreRequest.Builder	vertices(List<VertexDefinition> list)	API name: 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)

API name: connections

connections

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

API name: connections

controls

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

API name: controls

controls

public final ExploreRequest.Builder controls(Function<ExploreControls.Builder,ObjectBuilder<ExploreControls>> fn)

API name: controls

index

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

Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

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

Required - A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

query

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

API name: query

query

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

API name: query

routing

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

Specific routing value

API name: routing

timeout

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

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

type

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

A comma-separated list of document types to search; leave empty to perform the operation on all types

API name: type

Adds all elements of list to type.

type

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

A comma-separated list of document types to search; leave empty to perform the operation on all types

API name: type

Adds one or more values to type.

vertices

public final ExploreRequest.Builder vertices(List<VertexDefinition> list)

API name: vertices

Adds all elements of list to vertices.

vertices

public final ExploreRequest.Builder vertices(VertexDefinition value,
 VertexDefinition... values)

API name: vertices

Adds one or more values to vertices.

vertices

public final ExploreRequest.Builder vertices(Function<VertexDefinition.Builder,ObjectBuilder<VertexDefinition>> fn)

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.