Package org.opensearch.client.opensearch.ml

Class UploadModelRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.UploadModelRequest

All Implemented Interfaces:

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

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

Registers a model.

Nested Class Summary

Nested Classes

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

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<UploadModelRequest>	_DESERIALIZER	Json deserializer for UploadModelRequest
static Endpoint<UploadModelRequest,UploadModelResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.upload_model".

Method Summary

Modifier and Type	Method	Description
static UploadModelRequest.Builder	builder()
java.lang.String	description()	The model description.
boolean	equals(java.lang.Object o)
int	hashCode()
ModelFormat	modelFormat()	API name: model_format
java.lang.String	modelGroupId()	API name: model_group_id
java.lang.String	name()	Required - The model name.
static UploadModelRequest	of(java.util.function.Function<UploadModelRequest.Builder,ObjectBuilder<UploadModelRequest>> 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	setupUploadModelRequestDeserializer(ObjectDeserializer<UploadModelRequest.Builder> op)
UploadModelRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
java.lang.String	version()	Required - 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 Detail

_DESERIALIZER

public static final JsonpDeserializer<UploadModelRequest> _DESERIALIZER

Json deserializer for UploadModelRequest

_ENDPOINT

public static final Endpoint<UploadModelRequest,UploadModelResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.upload_model".

Method Detail

of

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

description

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

The model description.

API name: description

modelFormat

@Nullable
public final ModelFormat modelFormat()

API name: model_format

modelGroupId

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

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

Returns:

a new builder instance.

builder

@Nonnull
public static UploadModelRequest.Builder builder()

setupUploadModelRequestDeserializer

protected static void setupUploadModelRequestDeserializer(ObjectDeserializer<UploadModelRequest.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