Package org.opensearch.client.opensearch.ml

Class RegisterModelMetaRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<RegisterModelMetaRequest.Builder>

org.opensearch.client.opensearch.ml.RegisterModelMetaRequest.Builder

All Implemented Interfaces:

CopyableBuilder<RegisterModelMetaRequest.Builder,RegisterModelMetaRequest>, MutableBuilder<RegisterModelMetaRequest.Builder,RegisterModelMetaRequest>, ObjectBuilder<RegisterModelMetaRequest>

Enclosing class:

RegisterModelMetaRequest

public static class RegisterModelMetaRequest.Builder
extends RequestBase.AbstractBuilder<RegisterModelMetaRequest.Builder>
implements CopyableBuilder<RegisterModelMetaRequest.Builder,RegisterModelMetaRequest>

Builder for RegisterModelMetaRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RegisterModelMetaRequest	build()	Builds a RegisterModelMetaRequest.
RegisterModelMetaRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RegisterModelMetaRequest.Builder	description(String value)	The model description.
final RegisterModelMetaRequest.Builder	modelConfig(Function<ModelConfig.Builder,ObjectBuilder<ModelConfig>> fn)	Required - API name: model_config
final RegisterModelMetaRequest.Builder	modelConfig(ModelConfig value)	Required - API name: model_config
final RegisterModelMetaRequest.Builder	modelContentHashValue(String value)	Required - The model content hash value.
final RegisterModelMetaRequest.Builder	modelFormat(ModelFormat value)	Required - API name: model_format
final RegisterModelMetaRequest.Builder	modelGroupId(String value)	API name: model_group_id
final RegisterModelMetaRequest.Builder	name(String value)	Required - The model name.
protected RegisterModelMetaRequest.Builder	self()
final RegisterModelMetaRequest.Builder	totalChunks(long value)	Required - Number of chunks the model is split into.
final RegisterModelMetaRequest.Builder	url(String value)	The model URL.
final RegisterModelMetaRequest.Builder	version(String value)	Required - API name: version

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public RegisterModelMetaRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<RegisterModelMetaRequest.Builder,RegisterModelMetaRequest>

Returns:

a new builder instance.

self

@Nonnull
protected RegisterModelMetaRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RegisterModelMetaRequest.Builder>

description

@Nonnull
public final RegisterModelMetaRequest.Builder description(@Nullable
 String value)

The model description.

API name: description

modelConfig

@Nonnull
public final RegisterModelMetaRequest.Builder modelConfig(ModelConfig value)

Required - API name: model_config

modelConfig

@Nonnull
public final RegisterModelMetaRequest.Builder modelConfig(Function<ModelConfig.Builder,ObjectBuilder<ModelConfig>> fn)

Required - API name: model_config

modelContentHashValue

@Nonnull
public final RegisterModelMetaRequest.Builder modelContentHashValue(String value)

Required - The model content hash value.

API name: model_content_hash_value

modelFormat

@Nonnull
public final RegisterModelMetaRequest.Builder modelFormat(ModelFormat value)

Required - API name: model_format

modelGroupId

@Nonnull
public final RegisterModelMetaRequest.Builder modelGroupId(@Nullable
 String value)

API name: model_group_id

name

@Nonnull
public final RegisterModelMetaRequest.Builder name(String value)

Required - The model name.

API name: name

totalChunks

@Nonnull
public final RegisterModelMetaRequest.Builder totalChunks(long value)

Required - Number of chunks the model is split into.

API name: total_chunks

url

@Nonnull
public final RegisterModelMetaRequest.Builder url(@Nullable
 String value)

The model URL.

API name: url

version

@Nonnull
public final RegisterModelMetaRequest.Builder version(String value)

Required - API name: version

build

@Nonnull
public RegisterModelMetaRequest build()

Builds a RegisterModelMetaRequest.

Specified by:

build in interface ObjectBuilder<RegisterModelMetaRequest>

Throws:

NullPointerException - if some of the required fields are null.