Package org.opensearch.client.opensearch.ml

Class RegisterModelMetaRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.RegisterModelMetaRequest

All Implemented Interfaces:

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

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

Registers model metadata.

Nested Class Summary

Nested Classes

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

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<RegisterModelMetaRequest>	_DESERIALIZER	Json deserializer for RegisterModelMetaRequest
static final Endpoint<RegisterModelMetaRequest,RegisterModelMetaResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.register_model_meta".

Method Summary

Modifier and Type	Method	Description
static RegisterModelMetaRequest.Builder	builder()
final String	description()	The model description.
boolean	equals(Object o)
int	hashCode()
final ModelConfig	modelConfig()	Required - API name: model_config
final String	modelContentHashValue()	Required - The model content hash value.
final ModelFormat	modelFormat()	Required - API name: model_format
final String	modelGroupId()	API name: model_group_id
final String	name()	Required - The model name.
static RegisterModelMetaRequest	of(Function<RegisterModelMetaRequest.Builder,ObjectBuilder<RegisterModelMetaRequest>> 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	setupRegisterModelMetaRequestDeserializer(ObjectDeserializer<RegisterModelMetaRequest.Builder> op)
RegisterModelMetaRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final long	totalChunks()	Required - Number of chunks the model is split into.
final String	url()	The model URL.
final 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 Details

_DESERIALIZER

public static final JsonpDeserializer<RegisterModelMetaRequest> _DESERIALIZER

Json deserializer for RegisterModelMetaRequest

_ENDPOINT

public static final Endpoint<RegisterModelMetaRequest,RegisterModelMetaResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.register_model_meta".

Method Details

of

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

description

@Nullable
public final String description()

The model description.

API name: description

modelConfig

@Nonnull
public final ModelConfig modelConfig()

Required - API name: model_config

modelContentHashValue

@Nonnull
public final String modelContentHashValue()

Required - The model content hash value.

API name: model_content_hash_value

modelFormat

@Nonnull
public final ModelFormat modelFormat()

Required - 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

totalChunks

public final long totalChunks()

Required - Number of chunks the model is split into.

API name: total_chunks

url

@Nullable
public final String url()

The model URL.

API name: url

version

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

Returns:

a new builder instance.

builder

@Nonnull
public static RegisterModelMetaRequest.Builder builder()

setupRegisterModelMetaRequestDeserializer

protected static void setupRegisterModelMetaRequestDeserializer(ObjectDeserializer<RegisterModelMetaRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object