Package org.opensearch.client.opensearch.ml

Class RegisterModelRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.RegisterModelRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RegisterModelRequest
extends RequestBase
implements PlainJsonSerializable

Registers a model.

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<RegisterModelRequest>	_DESERIALIZER	Json deserializer for RegisterModelRequest
static Endpoint<RegisterModelRequest,RegisterModelResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.register_model".

Method Summary

Modifier and Type	Method	Description
java.lang.String	description()	The model description.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	modelFormat()	Required - The portable format of the model file.
java.lang.String	modelGroupId()	The ID of the model group to which to register the model.
java.lang.String	name()	Required - The model name.
static RegisterModelRequest	of(java.util.function.Function<RegisterModelRequest.Builder,ObjectBuilder<RegisterModelRequest>> 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	setupRegisterModelRequestDeserializer(ObjectDeserializer<RegisterModelRequest.Builder> op)
java.lang.String	version()	Required - The model version.

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<RegisterModelRequest> _DESERIALIZER

Json deserializer for RegisterModelRequest

_ENDPOINT

public static final Endpoint<RegisterModelRequest,RegisterModelResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.register_model".

Method Detail

of

public static RegisterModelRequest of(java.util.function.Function<RegisterModelRequest.Builder,ObjectBuilder<RegisterModelRequest>> fn)

description

@Nullable
public final java.lang.String description()

The model description.

API name: description

modelFormat

@Nonnull
public final java.lang.String modelFormat()

Required - The portable format of the model file.

API name: model_format

modelGroupId

@Nullable
public final java.lang.String modelGroupId()

The ID of the model group to which to register the model.

API name: model_group_id

name

@Nonnull
public final java.lang.String name()

Required - The model name.

API name: name

version

@Nonnull
public final java.lang.String version()

Required - The model version.

API name: version

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)

setupRegisterModelRequestDeserializer

protected static void setupRegisterModelRequestDeserializer(ObjectDeserializer<RegisterModelRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object