Package org.opensearch.client.opensearch.nodes

Class InfoRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.nodes.InfoRequest.Builder

All Implemented Interfaces:

ObjectBuilder<InfoRequest>

Enclosing class:

InfoRequest

public static class InfoRequest.Builder
extends java.lang.Object
implements ObjectBuilder<InfoRequest>

Builder for InfoRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InfoRequest.Builder	addMetric(java.lang.String value)	Add a value to metric(List), creating the list if needed.
InfoRequest	build()	Builds a InfoRequest.
InfoRequest.Builder	flatSettings(java.lang.Boolean value)	If true, returns settings in flat format.
InfoRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	Period to wait for a connection to the master node.
InfoRequest.Builder	metric(java.lang.String... value)	Limits the information returned to the specific metrics.
InfoRequest.Builder	metric(java.util.List<java.lang.String> value)	Limits the information returned to the specific metrics.
InfoRequest.Builder	nodeId(java.lang.String value)	Comma-separated list of node IDs or names used to limit returned information.
InfoRequest.Builder	timeout(jakarta.json.JsonValue value)	Period to wait for a response.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

nodeId

public InfoRequest.Builder nodeId(@Nullable java.lang.String value)

Comma-separated list of node IDs or names used to limit returned information. API name: node_id

metric

public InfoRequest.Builder metric(@Nullable java.util.List<java.lang.String> value)

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. API name: metric

metric

public InfoRequest.Builder metric(java.lang.String... value)

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. API name: metric

addMetric

public InfoRequest.Builder addMetric(java.lang.String value)

Add a value to metric(List), creating the list if needed.

flatSettings

public InfoRequest.Builder flatSettings(@Nullable java.lang.Boolean value)

If true, returns settings in flat format. API name: flat_settings

masterTimeout

public InfoRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

timeout

public InfoRequest.Builder timeout(@Nullable jakarta.json.JsonValue value)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

build

public InfoRequest build()

Builds a InfoRequest.

Specified by:

build in interface ObjectBuilder<InfoRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.