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

Class IndexSegment.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.segments.IndexSegment.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexSegment

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

Builder for IndexSegment.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexSegment	build()	Builds a IndexSegment.
IndexSegment.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexSegment.Builder	shards(String key, List<ShardsSegment> value)	Required - The segment information for each shard.
final IndexSegment.Builder	shards(Map<String,List<ShardsSegment>> map)	Required - The segment information for each shard.

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

Returns:

a new builder instance.

shards

@Nonnull
public final IndexSegment.Builder shards(Map<String,List<ShardsSegment>> map)

Required - The segment information for each shard.

API name: shards

Adds all elements of map to shards.

shards

@Nonnull
public final IndexSegment.Builder shards(String key,
 List<ShardsSegment> value)

Required - The segment information for each shard.

API name: shards

Adds an entry to shards.

build

@Nonnull
public IndexSegment build()

Builds a IndexSegment.

Specified by:

build in interface ObjectBuilder<IndexSegment>

Throws:

NullPointerException - if some of the required fields are null.