Package org.opensearch.client.opensearch.ml

Class RateLimiter

java.lang.Object

org.opensearch.client.opensearch.ml.RateLimiter

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RateLimiter.Builder,RateLimiter>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RateLimiter
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<RateLimiter.Builder,RateLimiter>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RateLimiter.Builder	Builder for RateLimiter.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RateLimiter>	_DESERIALIZER	Json deserializer for RateLimiter

Method Summary

Modifier and Type	Method	Description
static RateLimiter.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final double	limit()	Required - The maximum limit.
static RateLimiter	of(Function<RateLimiter.Builder,ObjectBuilder<RateLimiter>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRateLimiterDeserializer(ObjectDeserializer<RateLimiter.Builder> op)
RateLimiter.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	unit()	Required - The unit of time.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RateLimiter> _DESERIALIZER

Json deserializer for RateLimiter

Method Details

of

public static RateLimiter of(Function<RateLimiter.Builder,ObjectBuilder<RateLimiter>> fn)

limit

public final double limit()

Required - The maximum limit.

API name: limit

unit

@Nonnull
public final String unit()

Required - The unit of time.

API name: unit

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public RateLimiter.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RateLimiter.Builder,RateLimiter>

Returns:

a new builder instance.

builder

@Nonnull
public static RateLimiter.Builder builder()

setupRateLimiterDeserializer

protected static void setupRateLimiterDeserializer(ObjectDeserializer<RateLimiter.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object