Package org.opensearch.client.opensearch.ml

Class CreateControllerRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.CreateControllerRequest

All Implemented Interfaces:

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

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

Creates a controller.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateControllerRequest>	_DESERIALIZER	Json deserializer for CreateControllerRequest
static final Endpoint<CreateControllerRequest,CreateControllerResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.create_controller".

Method Summary

Modifier and Type	Method	Description
static CreateControllerRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	modelId()	Required - API name: model_id
static CreateControllerRequest	of(Function<CreateControllerRequest.Builder,ObjectBuilder<CreateControllerRequest>> 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	setupCreateControllerRequestDeserializer(ObjectDeserializer<CreateControllerRequest.Builder> op)
CreateControllerRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Map<String,RateLimiter>	userRateLimiter()	API name: user_rate_limiter

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

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<CreateControllerRequest> _DESERIALIZER

Json deserializer for CreateControllerRequest

_ENDPOINT

public static final Endpoint<CreateControllerRequest,CreateControllerResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.create_controller".

Method Details

of

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

modelId

@Nonnull
public final String modelId()

Required - API name: model_id

userRateLimiter

@Nonnull
public final Map<String,RateLimiter> userRateLimiter()

API name: user_rate_limiter

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

Returns:

a new builder instance.

builder

@Nonnull
public static CreateControllerRequest.Builder builder()

setupCreateControllerRequestDeserializer

protected static void setupCreateControllerRequestDeserializer(ObjectDeserializer<CreateControllerRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object