Package org.opensearch.client.opensearch.ml

Class UnloadModelRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.UnloadModelRequest

All Implemented Interfaces:

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

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

Unloads a model.

Nested Class Summary

Nested Classes

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

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<UnloadModelRequest>	_DESERIALIZER	Json deserializer for UnloadModelRequest
static final Endpoint<UnloadModelRequest,UnloadModelResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.unload_model".

Method Summary

Modifier and Type	Method	Description
static UnloadModelRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	modelId()	API name: model_id
final List<String>	modelIds()	API name: model_ids
final List<String>	nodeIds()	API name: node_ids
static UnloadModelRequest	of(Function<UnloadModelRequest.Builder,ObjectBuilder<UnloadModelRequest>> 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	setupUnloadModelRequestDeserializer(ObjectDeserializer<UnloadModelRequest.Builder> op)
UnloadModelRequest.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<UnloadModelRequest> _DESERIALIZER

Json deserializer for UnloadModelRequest

_ENDPOINT

public static final Endpoint<UnloadModelRequest,UnloadModelResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.unload_model".

Method Details

of

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

modelId

@Nullable
public final String modelId()

API name: model_id

modelIds

@Nonnull
public final List<String> modelIds()

API name: model_ids

nodeIds

@Nonnull
public final List<String> nodeIds()

API name: node_ids

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

Returns:

a new builder instance.

builder

@Nonnull
public static UnloadModelRequest.Builder builder()

setupUnloadModelRequestDeserializer

protected static void setupUnloadModelRequestDeserializer(ObjectDeserializer<UnloadModelRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object