Package org.opensearch.client.opensearch.cat

Class SegmentsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch.cat.SegmentsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SegmentsRequest

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

Builder for SegmentsRequest.

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
SegmentsRequest	build()	Builds a SegmentsRequest.
final SegmentsRequest.Builder	bytes(Bytes value)	The units used to display byte values.
final SegmentsRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final SegmentsRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
SegmentsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SegmentsRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final SegmentsRequest.Builder	index(List<String> list)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final SegmentsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final SegmentsRequest.Builder	masterTimeout(Time value)	Deprecated.
protected SegmentsRequest.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 SegmentsRequest.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<SegmentsRequest.Builder,SegmentsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected SegmentsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SegmentsRequest.Builder>

bytes

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

The units used to display byte values.

API name: bytes

clusterManagerTimeout

@Nonnull
public final SegmentsRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final SegmentsRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

index

@Nonnull
public final SegmentsRequest.Builder index(List<String> list)

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final SegmentsRequest.Builder index(String value,
 String... values)

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

masterTimeout

@Deprecated
@Nonnull
public final SegmentsRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final SegmentsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

build

@Nonnull
public SegmentsRequest build()

Builds a SegmentsRequest.

Specified by:

build in interface ObjectBuilder<SegmentsRequest>

Throws:

NullPointerException - if some of the required fields are null.