Package org.opensearch.client.opensearch.ml

Class RegisterModelRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

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

Enclosing class:

RegisterModelRequest

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

Builder for RegisterModelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RegisterModelRequest	build()	Builds a RegisterModelRequest.
final RegisterModelRequest.Builder	connectorId(String value)	The connector ID.
RegisterModelRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RegisterModelRequest.Builder	description(String value)	The model description.
final RegisterModelRequest.Builder	functionName(String value)	The function name.
final RegisterModelRequest.Builder	modelFormat(ModelFormat value)	API name: model_format
final RegisterModelRequest.Builder	modelGroupId(String value)	API name: model_group_id
final RegisterModelRequest.Builder	name(String value)	Required - The model name.
protected RegisterModelRequest.Builder	self()
final RegisterModelRequest.Builder	version(String value)	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 RegisterModelRequest.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<RegisterModelRequest.Builder,RegisterModelRequest>

Returns:

a new builder instance.

self

@Nonnull
protected RegisterModelRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RegisterModelRequest.Builder>

connectorId

@Nonnull
public final RegisterModelRequest.Builder connectorId(@Nullable
 String value)

The connector ID.

API name: connector_id

description

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

The model description.

API name: description

functionName

@Nonnull
public final RegisterModelRequest.Builder functionName(@Nullable
 String value)

The function name.

API name: function_name

modelFormat

@Nonnull
public final RegisterModelRequest.Builder modelFormat(@Nullable
 ModelFormat value)

API name: model_format

modelGroupId

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

API name: model_group_id

name

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

Required - The model name.

API name: name

version

@Nonnull
public final RegisterModelRequest.Builder version(@Nullable
 String value)

API name: version

build

@Nonnull
public RegisterModelRequest build()

Builds a RegisterModelRequest.

Specified by:

build in interface ObjectBuilder<RegisterModelRequest>

Throws:

NullPointerException - if some of the required fields are null.