Package org.opensearch.client.opensearch.ml

Class ModelProfile.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.ModelProfile.Builder

All Implemented Interfaces:

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

Enclosing class:

ModelProfile

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

Builder for ModelProfile.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ModelProfile	build()	Builds a ModelProfile.
ModelProfile.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
ModelProfile.Builder	deploy(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)	API name: deploy
ModelProfile.Builder	deploy(ModelStats value)	API name: deploy
ModelProfile.Builder	execute(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)	API name: execute
ModelProfile.Builder	execute(ModelStats value)	API name: execute
ModelProfile.Builder	memorySizeEstimationCpu(java.lang.Long value)	The estimated memory size in CPU.
ModelProfile.Builder	memorySizeEstimationGpu(java.lang.Long value)	The estimated memory size in GPU.
ModelProfile.Builder	modelState(java.lang.String value)	The model state.
ModelProfile.Builder	predict(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)	API name: predict
ModelProfile.Builder	predict(ModelStats value)	API name: predict
ModelProfile.Builder	predictor(java.lang.String value)	The predictor.
ModelProfile.Builder	predictRequestStats(java.util.function.Function<PredictRequestStats.Builder,ObjectBuilder<PredictRequestStats>> fn)	API name: predict_request_stats
ModelProfile.Builder	predictRequestStats(PredictRequestStats value)	API name: predict_request_stats
ModelProfile.Builder	register(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)	API name: register
ModelProfile.Builder	register(ModelStats value)	API name: register
ModelProfile.Builder	targetWorkerNodes(java.util.List<java.lang.String> value, java.util.List<java.lang.String>... values)	API name: target_worker_nodes
ModelProfile.Builder	targetWorkerNodes(java.util.List<java.util.List<java.lang.String>> list)	API name: target_worker_nodes
ModelProfile.Builder	train(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)	API name: train
ModelProfile.Builder	train(ModelStats value)	API name: train
ModelProfile.Builder	trainPredict(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)	API name: train_predict
ModelProfile.Builder	trainPredict(ModelStats value)	API name: train_predict
ModelProfile.Builder	undeploy(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)	API name: undeploy
ModelProfile.Builder	undeploy(ModelStats value)	API name: undeploy
ModelProfile.Builder	workerNodes(java.util.List<java.lang.String> value, java.util.List<java.lang.String>... values)	API name: worker_nodes
ModelProfile.Builder	workerNodes(java.util.List<java.util.List<java.lang.String>> list)	API name: worker_nodes

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

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

Returns:

a new builder instance.

deploy

@Nonnull
public final ModelProfile.Builder deploy(@Nullable
                                         ModelStats value)

API name: deploy

deploy

@Nonnull
public final ModelProfile.Builder deploy(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)

API name: deploy

execute

@Nonnull
public final ModelProfile.Builder execute(@Nullable
                                          ModelStats value)

API name: execute

execute

@Nonnull
public final ModelProfile.Builder execute(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)

API name: execute

memorySizeEstimationCpu

@Nonnull
public final ModelProfile.Builder memorySizeEstimationCpu(@Nullable
                                                          java.lang.Long value)

The estimated memory size in CPU.

API name: memory_size_estimation_cpu

memorySizeEstimationGpu

@Nonnull
public final ModelProfile.Builder memorySizeEstimationGpu(@Nullable
                                                          java.lang.Long value)

The estimated memory size in GPU.

API name: memory_size_estimation_gpu

modelState

@Nonnull
public final ModelProfile.Builder modelState(@Nullable
                                             java.lang.String value)

The model state.

API name: model_state

predict

@Nonnull
public final ModelProfile.Builder predict(@Nullable
                                          ModelStats value)

API name: predict

predict

@Nonnull
public final ModelProfile.Builder predict(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)

API name: predict

predictRequestStats

@Nonnull
public final ModelProfile.Builder predictRequestStats(@Nullable
                                                      PredictRequestStats value)

API name: predict_request_stats

predictRequestStats

@Nonnull
public final ModelProfile.Builder predictRequestStats(java.util.function.Function<PredictRequestStats.Builder,ObjectBuilder<PredictRequestStats>> fn)

API name: predict_request_stats

predictor

@Nonnull
public final ModelProfile.Builder predictor(@Nullable
                                            java.lang.String value)

The predictor.

API name: predictor

register

@Nonnull
public final ModelProfile.Builder register(@Nullable
                                           ModelStats value)

API name: register

register

@Nonnull
public final ModelProfile.Builder register(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)

API name: register

targetWorkerNodes

@Nonnull
public final ModelProfile.Builder targetWorkerNodes(java.util.List<java.util.List<java.lang.String>> list)

API name: target_worker_nodes

Adds all elements of list to targetWorkerNodes.

targetWorkerNodes

@Nonnull
public final ModelProfile.Builder targetWorkerNodes(java.util.List<java.lang.String> value,
                                                    java.util.List<java.lang.String>... values)

API name: target_worker_nodes

Adds one or more values to targetWorkerNodes.

train

@Nonnull
public final ModelProfile.Builder train(@Nullable
                                        ModelStats value)

API name: train

train

@Nonnull
public final ModelProfile.Builder train(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)

API name: train

trainPredict

@Nonnull
public final ModelProfile.Builder trainPredict(@Nullable
                                               ModelStats value)

API name: train_predict

trainPredict

@Nonnull
public final ModelProfile.Builder trainPredict(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)

API name: train_predict

undeploy

@Nonnull
public final ModelProfile.Builder undeploy(@Nullable
                                           ModelStats value)

API name: undeploy

undeploy

@Nonnull
public final ModelProfile.Builder undeploy(java.util.function.Function<ModelStats.Builder,ObjectBuilder<ModelStats>> fn)

API name: undeploy

workerNodes

@Nonnull
public final ModelProfile.Builder workerNodes(java.util.List<java.util.List<java.lang.String>> list)

API name: worker_nodes

Adds all elements of list to workerNodes.

workerNodes

@Nonnull
public final ModelProfile.Builder workerNodes(java.util.List<java.lang.String> value,
                                              java.util.List<java.lang.String>... values)

API name: worker_nodes

Adds one or more values to workerNodes.

build

@Nonnull
public ModelProfile build()

Builds a ModelProfile.

Specified by:

build in interface ObjectBuilder<ModelProfile>

Throws:

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