Package org.opensearch.client.opensearch.ml

Class UpdateModelRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.UpdateModelRequest

All Implemented Interfaces:

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

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

Updates a model.

Nested Class Summary

Nested Classes

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

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<UpdateModelRequest>	_DESERIALIZER	Json deserializer for UpdateModelRequest
static final Endpoint<UpdateModelRequest,UpdateModelResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.update_model".

Method Summary

Modifier and Type	Method	Description
static UpdateModelRequest.Builder	builder()
final Map<String,JsonData>	connector()	The connector to use for the model.
final String	connectorId()	The connector ID.
final String	description()	The model description.
boolean	equals(Object o)
final Guardrails	guardrails()	API name: guardrails
int	hashCode()
final Map<String,JsonData>	interface_()	The model interface.
final Boolean	isEnabled()	Whether the model is enabled.
final ModelConfig	modelConfig()	API name: model_config
final String	modelId()	Required - API name: model_id
final String	name()	The model name.
static UpdateModelRequest	of(Function<UpdateModelRequest.Builder,ObjectBuilder<UpdateModelRequest>> fn)
final RateLimiter	rateLimiter()	API name: rate_limiter
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	setupUpdateModelRequestDeserializer(ObjectDeserializer<UpdateModelRequest.Builder> op)
UpdateModelRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

Json deserializer for UpdateModelRequest

_ENDPOINT

public static final Endpoint<UpdateModelRequest,UpdateModelResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.update_model".

Method Details

of

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

connector

@Nonnull
public final Map<String,JsonData> connector()

The connector to use for the model.

API name: connector

connectorId

@Nullable
public final String connectorId()

The connector ID.

API name: connector_id

description

@Nullable
public final String description()

The model description.

API name: description

guardrails

@Nullable
public final Guardrails guardrails()

API name: guardrails

interface_

@Nonnull
public final Map<String,JsonData> interface_()

The model interface.

API name: interface

isEnabled

@Nullable
public final Boolean isEnabled()

Whether the model is enabled.

API name: is_enabled

modelConfig

@Nullable
public final ModelConfig modelConfig()

API name: model_config

modelId

@Nonnull
public final String modelId()

Required - API name: model_id

name

@Nullable
public final String name()

The model name.

API name: name

rateLimiter

@Nullable
public final RateLimiter rateLimiter()

API name: 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 UpdateModelRequest.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<UpdateModelRequest.Builder,UpdateModelRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static UpdateModelRequest.Builder builder()

setupUpdateModelRequestDeserializer

protected static void setupUpdateModelRequestDeserializer(ObjectDeserializer<UpdateModelRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object