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, ToCopyableBuilder<RegisterModelRequest.Builder,RegisterModelRequest>

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

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

Method Summary

Modifier and Type	Method	Description
static RegisterModelRequest.Builder	builder()
final String	connectorId()	The connector ID.
final String	description()	The model description.
boolean	equals(Object o)
final String	functionName()	The function name.
int	hashCode()
final ModelFormat	modelFormat()	API name: model_format
final String	modelGroupId()	API name: model_group_id
final String	name()	Required - The model name.
static RegisterModelRequest	of(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)
RegisterModelRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	version()	API name: version

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

Json deserializer for RegisterModelRequest

_ENDPOINT

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

Endpoint "ml.register_model".

Method Details

of

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

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

functionName

@Nullable
public final String functionName()

The function name.

API name: function_name

modelFormat

@Nullable
public final ModelFormat modelFormat()

API name: model_format

modelGroupId

@Nullable
public final String modelGroupId()

API name: model_group_id

name

@Nonnull
public final String name()

Required - The model name.

API name: name

version

@Nullable
public final String 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)

toBuilder

@Nonnull
public RegisterModelRequest.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<RegisterModelRequest.Builder,RegisterModelRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static RegisterModelRequest.Builder builder()

setupRegisterModelRequestDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object