Package org.opensearch.client.opensearch._types.aggregations

Class TermsPartition.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.TermsPartition.Builder

All Implemented Interfaces:

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

Enclosing class:

TermsPartition

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

Builder for TermsPartition.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermsPartition	build()	Builds a TermsPartition.
TermsPartition.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TermsPartition.Builder	numPartitions(long value)	Required - The number of partitions.
final TermsPartition.Builder	partition(long value)	Required - The partition number for this request.

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

Returns:

a new builder instance.

numPartitions

@Nonnull
public final TermsPartition.Builder numPartitions(long value)

Required - The number of partitions.

API name: num_partitions

partition

@Nonnull
public final TermsPartition.Builder partition(long value)

Required - The partition number for this request.

API name: partition

build

@Nonnull
public TermsPartition build()

Builds a TermsPartition.

Specified by:

build in interface ObjectBuilder<TermsPartition>

Throws:

NullPointerException - if some of the required fields are null.