Package org.opensearch.client.opensearch.cat

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

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<BuilderT>

Direct Known Subclasses:

AliasesRequest.Builder, AllocationRequest.Builder, AllPitSegmentsRequest.Builder, ClusterManagerRequest.Builder, CountRequest.Builder, FielddataRequest.Builder, HealthRequest.Builder, IndicesRequest.Builder, MasterRequest.Builder, NodeattrsRequest.Builder, NodesRequest.Builder, PendingTasksRequest.Builder, PitSegmentsRequest.Builder, PluginsRequest.Builder, RecoveryRequest.Builder, RepositoriesRequest.Builder, SegmentReplicationRequest.Builder, SegmentsRequest.Builder, ShardsRequest.Builder, SnapshotsRequest.Builder, TasksRequest.Builder, TemplatesRequest.Builder, ThreadPoolRequest.Builder

Enclosing class:

CatRequestBase

public abstract static class CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
extends RequestBase.AbstractBuilder<BuilderT>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	headers
protected List<String>	sort

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()
protected	AbstractBuilder(CatRequestBase o)
protected	AbstractBuilder(CatRequestBase.AbstractBuilder<BuilderT> o)

Method Summary

Modifier and Type	Method	Description
final BuilderT	headers(String value, String... values)	A comma-separated list of specific headers to limits the output
final BuilderT	headers(List<String> values)	A comma-separated list of specific headers to limits the output
final BuilderT	sort(String value, String... values)	A comma-separated list of headers to sort the returned information
final BuilderT	sort(List<String> values)	A comma-separated list of headers to sort the returned information

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

errorTrace, human, self

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

Field Details

headers

@Nullable
protected List<String> headers

sort

@Nullable
protected List<String> sort

Constructor Details

AbstractBuilder

protected AbstractBuilder()

AbstractBuilder

protected AbstractBuilder(CatRequestBase o)

AbstractBuilder

protected AbstractBuilder(CatRequestBase.AbstractBuilder<BuilderT> o)

Method Details

headers

@Nonnull
public final BuilderT headers(List<String> values)

A comma-separated list of specific headers to limits the output

API name: h

headers

@Nonnull
public final BuilderT headers(String value,
 String... values)

A comma-separated list of specific headers to limits the output

API name: h

sort

@Nonnull
public final BuilderT sort(List<String> values)

A comma-separated list of headers to sort the returned information

API name: s

sort

@Nonnull
public final BuilderT sort(String value,
 String... values)

A comma-separated list of headers to sort the returned information

API name: s