Package org.opensearch.client.opensearch.cat

Class SegmentReplicationRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch.cat.SegmentReplicationRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SegmentReplicationRequest

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

Builder for SegmentReplicationRequest.

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
final SegmentReplicationRequest.Builder	activeOnly(Boolean value)	When true, the response only includes ongoing segment replication events.
final SegmentReplicationRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore the index if a wildcard index expression resolves to no concrete indexes.
SegmentReplicationRequest	build()	Builds a SegmentReplicationRequest.
final SegmentReplicationRequest.Builder	bytes(Bytes value)	The units used to display byte values.
final SegmentReplicationRequest.Builder	completedOnly(Boolean value)	When true, the response only includes the last-completed segment replication events.
SegmentReplicationRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SegmentReplicationRequest.Builder	detailed(Boolean value)	When true, the response includes additional metrics for each stage of a segment replication event.
final SegmentReplicationRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Specifies the type of index that wildcard expressions can match.
final SegmentReplicationRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Specifies the type of index that wildcard expressions can match.
final SegmentReplicationRequest.Builder	ignoreThrottled(Boolean value)	Whether specified concrete, expanded, or aliased indexes should be ignored when throttled.
final SegmentReplicationRequest.Builder	ignoreUnavailable(Boolean value)	Whether the specified concrete indexes should be ignored when missing or closed.
final SegmentReplicationRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final SegmentReplicationRequest.Builder	index(List<String> list)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
protected SegmentReplicationRequest.Builder	self()
final SegmentReplicationRequest.Builder	shards(String value, String... values)	A comma-separated list of shards to display.
final SegmentReplicationRequest.Builder	shards(List<String> list)	A comma-separated list of shards to display.
final SegmentReplicationRequest.Builder	time(TimeUnit value)	Specifies the time units, for example, 5d or 7h.
final SegmentReplicationRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The operation timeout.
final SegmentReplicationRequest.Builder	timeout(Time value)	The operation timeout.

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

Returns:

a new builder instance.

self

@Nonnull
protected SegmentReplicationRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SegmentReplicationRequest.Builder>

activeOnly

@Nonnull
public final SegmentReplicationRequest.Builder activeOnly(@Nullable
 Boolean value)

When true, the response only includes ongoing segment replication events.

API name: active_only

allowNoIndices

@Nonnull
public final SegmentReplicationRequest.Builder allowNoIndices(@Nullable
 Boolean value)

Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the _all string or when no indexes have been specified.

API name: allow_no_indices

bytes

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

The units used to display byte values.

API name: bytes

completedOnly

@Nonnull
public final SegmentReplicationRequest.Builder completedOnly(@Nullable
 Boolean value)

When true, the response only includes the last-completed segment replication events.

API name: completed_only

detailed

@Nonnull
public final SegmentReplicationRequest.Builder detailed(@Nullable
 Boolean value)

When true, the response includes additional metrics for each stage of a segment replication event.

API name: detailed

expandWildcards

@Nonnull
public final SegmentReplicationRequest.Builder expandWildcards(List<ExpandWildcard> list)

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final SegmentReplicationRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreThrottled

@Nonnull
public final SegmentReplicationRequest.Builder ignoreThrottled(@Nullable
 Boolean value)

Whether specified concrete, expanded, or aliased indexes should be ignored when throttled.

API name: ignore_throttled

ignoreUnavailable

@Nonnull
public final SegmentReplicationRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

Whether the specified concrete indexes should be ignored when missing or closed.

API name: ignore_unavailable

index

@Nonnull
public final SegmentReplicationRequest.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 SegmentReplicationRequest.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.

shards

@Nonnull
public final SegmentReplicationRequest.Builder shards(List<String> list)

A comma-separated list of shards to display.

API name: shards

Adds all elements of list to shards.

shards

@Nonnull
public final SegmentReplicationRequest.Builder shards(String value,
 String... values)

A comma-separated list of shards to display.

API name: shards

Adds one or more values to shards.

time

@Nonnull
public final SegmentReplicationRequest.Builder time(@Nullable
 TimeUnit value)

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

timeout

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

The operation timeout.

API name: timeout

timeout

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

The operation timeout.

API name: timeout

build

@Nonnull
public SegmentReplicationRequest build()

Builds a SegmentReplicationRequest.

Specified by:

build in interface ObjectBuilder<SegmentReplicationRequest>

Throws:

NullPointerException - if some of the required fields are null.