Package org.opensearch.client.opensearch.ltr

Class LtrStatsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ltr.LtrStatsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

LtrStatsRequest

public static class LtrStatsRequest.Builder
extends RequestBase.AbstractBuilder<LtrStatsRequest.Builder>
implements CopyableBuilder<LtrStatsRequest.Builder,LtrStatsRequest>

Builder for LtrStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LtrStatsRequest	build()	Builds a LtrStatsRequest.
LtrStatsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final LtrStatsRequest.Builder	nodeId(String value, String... values)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.
final LtrStatsRequest.Builder	nodeId(List<String> list)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.
protected LtrStatsRequest.Builder	self()
final LtrStatsRequest.Builder	stat(List<LtrStatName> list)	A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.
final LtrStatsRequest.Builder	stat(LtrStatName value, LtrStatName... values)	A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.
final LtrStatsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The time in milliseconds to wait for a response.
final LtrStatsRequest.Builder	timeout(Time value)	The time in milliseconds to wait for a response.

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 LtrStatsRequest.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<LtrStatsRequest.Builder,LtrStatsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected LtrStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<LtrStatsRequest.Builder>

nodeId

@Nonnull
public final LtrStatsRequest.Builder nodeId(List<String> list)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

API name: node_id

Adds all elements of list to nodeId.

nodeId

@Nonnull
public final LtrStatsRequest.Builder nodeId(String value,
 String... values)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

API name: node_id

Adds one or more values to nodeId.

stat

@Nonnull
public final LtrStatsRequest.Builder stat(List<LtrStatName> list)

A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.

API name: stat

Adds all elements of list to stat.

stat

@Nonnull
public final LtrStatsRequest.Builder stat(LtrStatName value,
 LtrStatName... values)

A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.

API name: stat

Adds one or more values to stat.

timeout

@Nonnull
public final LtrStatsRequest.Builder timeout(@Nullable
 Time value)

The time in milliseconds to wait for a response.

API name: timeout

timeout

@Nonnull
public final LtrStatsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The time in milliseconds to wait for a response.

API name: timeout

build

@Nonnull
public LtrStatsRequest build()

Builds a LtrStatsRequest.

Specified by:

build in interface ObjectBuilder<LtrStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.