Package org.opensearch.client.opensearch.cat

Class FielddataRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<FielddataRequest.Builder>

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<FielddataRequest.Builder>

org.opensearch.client.opensearch.cat.FielddataRequest.Builder

All Implemented Interfaces:

CopyableBuilder<FielddataRequest.Builder,FielddataRequest>, MutableBuilder<FielddataRequest.Builder,FielddataRequest>, ObjectBuilder<FielddataRequest>

Enclosing class:

FielddataRequest

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

Builder for FielddataRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

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 units used to display byte values.
FielddataRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FielddataRequest.Builder	fields(String value, String... values)	A comma-separated list of fields used to limit the amount of returned information.
final FielddataRequest.Builder	fields(List<String> list)	A comma-separated list of fields used to limit the amount of returned information.
protected FielddataRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public FielddataRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<FielddataRequest.Builder,FielddataRequest>

Returns:

a new builder instance.

self

@Nonnull
protected FielddataRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<FielddataRequest.Builder>

bytes

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

The units used to display byte values.

API name: bytes

fields

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

A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.

API name: fields

Adds all elements of list to fields.

fields

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

A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.

API name: fields

Adds one or more values to fields.

build

@Nonnull
public FielddataRequest build()

Builds a FielddataRequest.

Specified by:

build in interface ObjectBuilder<FielddataRequest>

Throws:

NullPointerException - if some of the required fields are null.