Package co.elastic.clients.elasticsearch.cat

Class FielddataRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.FielddataRequest

public class FielddataRequest
extends CatRequestBase

Get field data cache information.

Get the amount of heap memory currently used by the field data cache on every data node in the cluster.

IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FielddataRequest.Builder	Builder for FielddataRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<FielddataRequest,FielddataResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.fielddata".

Method Summary

Modifier and Type	Method	Description
final Bytes	bytes()	The unit used to display byte values.
final List<String>	fields()	Comma-separated list of fields used to limit returned information.
final List<String>	h()	List of columns to appear in the response.
static FielddataRequest	of(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)
final List<String>	s()	List of columns that determine how the table should be sorted.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<FielddataRequest,FielddataResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.fielddata".

Method Details

of

public static FielddataRequest of(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)

bytes

@Nullable
public final Bytes bytes()

The unit used to display byte values.

API name: bytes

fields

public final List<String> fields()

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

API name: fields

h

public final List<String> h()

List of columns to appear in the response. Supports simple wildcards.

API name: h

s

public final List<String> s()

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