Package org.opensearch.client.opensearch.ml

Class ModelConfig.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.ModelConfig.Builder

All Implemented Interfaces:

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

Enclosing class:

ModelConfig

public static class ModelConfig.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ModelConfig.Builder,ModelConfig>

Builder for ModelConfig.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ModelConfig.Builder	allConfig(String value)	The all config.
ModelConfig	build()	Builds a ModelConfig.
ModelConfig.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ModelConfig.Builder	embeddingDimension(Long value)	The embedding dimension.
final ModelConfig.Builder	frameworkType(String value)	The framework type.
final ModelConfig.Builder	modelType(String value)	The model type.

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

Returns:

a new builder instance.

allConfig

@Nonnull
public final ModelConfig.Builder allConfig(@Nullable
 String value)

The all config.

API name: all_config

embeddingDimension

@Nonnull
public final ModelConfig.Builder embeddingDimension(@Nullable
 Long value)

The embedding dimension.

API name: embedding_dimension

frameworkType

@Nonnull
public final ModelConfig.Builder frameworkType(@Nullable
 String value)

The framework type.

API name: framework_type

modelType

@Nonnull
public final ModelConfig.Builder modelType(@Nullable
 String value)

The model type.

API name: model_type

build

@Nonnull
public ModelConfig build()

Builds a ModelConfig.

Specified by:

build in interface ObjectBuilder<ModelConfig>

Throws:

NullPointerException - if some of the required fields are null.