Package co.elastic.clients.elasticsearch.cat

Class FielddataRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<FielddataRequest.Builder>

co.elastic.clients.elasticsearch.cat.FielddataRequest.Builder

All Implemented Interfaces:

WithJson<FielddataRequest.Builder>, ObjectBuilder<FielddataRequest>

Enclosing class:

FielddataRequest

public static class FielddataRequest.Builder
extends CatRequestBase.AbstractBuilder<FielddataRequest.Builder>
implements ObjectBuilder<FielddataRequest>

Builder for FielddataRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FielddataRequest	build()	Builds a FielddataRequest.
final FielddataRequest.Builder	bytes(Bytes value)	The unit used to display byte values.
final FielddataRequest.Builder	fields(String value, String... values)	Comma-separated list of fields used to limit returned information.
final FielddataRequest.Builder	fields(List<String> list)	Comma-separated list of fields used to limit returned information.
final FielddataRequest.Builder	h(CatFieldDataColumn value, CatFieldDataColumn... values)	A comma-separated list of columns names to display.
final FielddataRequest.Builder	h(String value, String... values)	A comma-separated list of columns names to display.
final FielddataRequest.Builder	h(List<String> list)	A comma-separated list of columns names to display.
final FielddataRequest.Builder	s(String value, String... values)	List of columns that determine how the table should be sorted.
final FielddataRequest.Builder	s(List<String> list)	List of columns that determine how the table should be sorted.
protected FielddataRequest.Builder	self()

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

bytes

public final FielddataRequest.Builder bytes(@Nullable
 Bytes value)

The unit used to display byte values.

API name: bytes

fields

public final FielddataRequest.Builder fields(List<String> list)

Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.

API name: fields

Adds all elements of list to fields.

fields

public final FielddataRequest.Builder fields(String value,
 String... values)

Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.

API name: fields

Adds one or more values to fields.

h

public final FielddataRequest.Builder h(List<String> list)

A comma-separated list of columns names to display. It supports simple wildcards.

API name: h

Adds all elements of list to h.

h

public final FielddataRequest.Builder h(String value,
 String... values)

A comma-separated list of columns names to display. It supports simple wildcards.

API name: h

Adds one or more values to h.

h

public final FielddataRequest.Builder h(CatFieldDataColumn value,
 CatFieldDataColumn... values)

A comma-separated list of columns names to display. It supports simple wildcards.

API name: h

Adds one or more enum values to h.

s

public final FielddataRequest.Builder s(List<String> list)

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s

Adds all elements of list to s.

s

public final FielddataRequest.Builder s(String value,
 String... values)

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s

Adds one or more values to s.

self

protected FielddataRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<FielddataRequest.Builder>

build

public FielddataRequest build()

Builds a FielddataRequest.

Specified by:

build in interface ObjectBuilder<FielddataRequest>

Throws:

NullPointerException - if some of the required fields are null.