Package org.opensearch.client.opensearch.ml

Class RegisterModelRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.RegisterModelRequest.Builder

All Implemented Interfaces:

ObjectBuilder<RegisterModelRequest>

Enclosing class:

RegisterModelRequest

public static class RegisterModelRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RegisterModelRequest>

Builder for RegisterModelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RegisterModelRequest	build()	Builds a RegisterModelRequest.
RegisterModelRequest.Builder	description(java.lang.String value)	The model description.
RegisterModelRequest.Builder	modelFormat(java.lang.String value)	Required - The portable format of the model file.
RegisterModelRequest.Builder	modelGroupId(java.lang.String value)	The ID of the model group to which to register the model.
RegisterModelRequest.Builder	name(java.lang.String value)	Required - The model name.
RegisterModelRequest.Builder	version(java.lang.String value)	Required - The model version.

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

description

public final RegisterModelRequest.Builder description(@Nullable
                                                      java.lang.String value)

The model description.

API name: description

modelFormat

public final RegisterModelRequest.Builder modelFormat(java.lang.String value)

Required - The portable format of the model file.

API name: model_format

modelGroupId

public final RegisterModelRequest.Builder modelGroupId(@Nullable
                                                       java.lang.String value)

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

API name: model_group_id

name

public final RegisterModelRequest.Builder name(java.lang.String value)

Required - The model name.

API name: name

version

public final RegisterModelRequest.Builder version(java.lang.String value)

Required - The model version.

API name: version

build

public RegisterModelRequest build()

Builds a RegisterModelRequest.

Specified by:

build in interface ObjectBuilder<RegisterModelRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.