Package org.opensearch.client.opensearch.indices.segments

Class ShardsSegment.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.segments.ShardsSegment.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardsSegment

public static class ShardsSegment.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ShardsSegment.Builder,ShardsSegment>

Builder for ShardsSegment.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardsSegment	build()	Builds a ShardsSegment.
ShardsSegment.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardsSegment.Builder	numCommittedSegments(int value)	Required - The number of committed segments.
final ShardsSegment.Builder	numSearchSegments(int value)	Required - The number of segments available for search.
final ShardsSegment.Builder	routing(Function<ShardSegmentRouting.Builder,ObjectBuilder<ShardSegmentRouting>> fn)	Required - API name: routing
final ShardsSegment.Builder	routing(ShardSegmentRouting value)	Required - API name: routing
final ShardsSegment.Builder	segments(String key, Function<Segment.Builder,ObjectBuilder<Segment>> fn)	Required - The detailed information for each segment.
final ShardsSegment.Builder	segments(String key, Segment value)	Required - The detailed information for each segment.
final ShardsSegment.Builder	segments(Map<String,Segment> map)	Required - The detailed information for each segment.

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

Returns:

a new builder instance.

numCommittedSegments

@Nonnull
public final ShardsSegment.Builder numCommittedSegments(int value)

Required - The number of committed segments.

API name: num_committed_segments

numSearchSegments

@Nonnull
public final ShardsSegment.Builder numSearchSegments(int value)

Required - The number of segments available for search.

API name: num_search_segments

routing

@Nonnull
public final ShardsSegment.Builder routing(ShardSegmentRouting value)

Required - API name: routing

routing

@Nonnull
public final ShardsSegment.Builder routing(Function<ShardSegmentRouting.Builder,ObjectBuilder<ShardSegmentRouting>> fn)

Required - API name: routing

segments

@Nonnull
public final ShardsSegment.Builder segments(Map<String,Segment> map)

Required - The detailed information for each segment.

API name: segments

Adds all elements of map to segments.

segments

@Nonnull
public final ShardsSegment.Builder segments(String key,
 Segment value)

Required - The detailed information for each segment.

API name: segments

Adds an entry to segments.

segments

@Nonnull
public final ShardsSegment.Builder segments(String key,
 Function<Segment.Builder,ObjectBuilder<Segment>> fn)

Required - The detailed information for each segment.

API name: segments

Adds a value to segments using a builder lambda.

build

@Nonnull
public ShardsSegment build()

Builds a ShardsSegment.

Specified by:

build in interface ObjectBuilder<ShardsSegment>

Throws:

NullPointerException - if some of the required fields are null.