Package org.opensearch.client.opensearch.cat

Class CatRequestBase

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

Direct Known Subclasses:

AliasesRequest, AllocationRequest, ClusterManagerRequest, CountRequest, FielddataRequest, HealthRequest, HelpRequest, IndicesRequest, NodeattrsRequest, NodesRequest, PendingTasksRequest, PitSegmentsRequest, PluginsRequest, RecoveryRequest, RepositoriesRequest, SegmentsRequest, ShardsRequest, SnapshotsRequest, TasksRequest, TemplatesRequest, ThreadPoolRequest

public abstract class CatRequestBase
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
protected static class	CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
	CatRequestBase()
protected	CatRequestBase(CatRequestBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(java.util.Map<java.lang.String,java.lang.String> params)
java.lang.String	headers()	A comma-separated list of headers to limit the returned information
protected java.util.Map<java.lang.String,java.lang.String>	queryParameters()
java.lang.String	sort()	A comma-separated list of headers to sort the returned information

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

errorTrace, human

Methods inherited from class java.lang.Object

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

Constructor Detail

CatRequestBase

public CatRequestBase()

CatRequestBase

protected CatRequestBase(CatRequestBase.AbstractBuilder<?> builder)

Method Detail

headers

@Nullable
public final java.lang.String headers()

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

API name: h

sort

@Nullable
public final java.lang.String sort()

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

API name: s

applyQueryParameters

protected void applyQueryParameters(@Nonnull
                                    java.util.Map<java.lang.String,java.lang.String> params)

Overrides:

applyQueryParameters in class RequestBase

queryParameters

protected final java.util.Map<java.lang.String,java.lang.String> queryParameters()