Package org.opensearch.client.opensearch.ml

Class RateLimiter.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.RateLimiter.Builder

All Implemented Interfaces:

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

Enclosing class:

RateLimiter

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

Builder for RateLimiter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RateLimiter	build()	Builds a RateLimiter.
RateLimiter.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RateLimiter.Builder	limit(double value)	Required - The maximum limit.
final RateLimiter.Builder	unit(String value)	Required - The unit of time.

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

Returns:

a new builder instance.

limit

@Nonnull
public final RateLimiter.Builder limit(double value)

Required - The maximum limit.

API name: limit

unit

@Nonnull
public final RateLimiter.Builder unit(String value)

Required - The unit of time.

API name: unit

build

@Nonnull
public RateLimiter build()

Builds a RateLimiter.

Specified by:

build in interface ObjectBuilder<RateLimiter>

Throws:

NullPointerException - if some of the required fields are null.