java.lang.Object
- org.opensearch.client.opensearch.ml.ModelProfile

All Implemented Interfaces:: JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ModelProfile.Builder,ModelProfile>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ModelProfile
extends java.lang.Object
implements PlainJsonSerializable, ToCopyableBuilder<ModelProfile.Builder,ModelProfile>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ModelProfile.Builder
Builder for ModelProfile.

Field Summary

Fields
Modifier and Type Field Description

static JsonpDeserializer<ModelProfile> _DESERIALIZER
Json deserializer for ModelProfile

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModelProfile.Builder`	`builder()`
`ModelStats`	`deploy()`	API name: `deploy`
`boolean`	`equals(java.lang.Object o)`
`ModelStats`	`execute()`	API name: `execute`
`int`	`hashCode()`
`java.lang.Long`	`memorySizeEstimationCpu()`	The estimated memory size in CPU.
`java.lang.Long`	`memorySizeEstimationGpu()`	The estimated memory size in GPU.
`java.lang.String`	`modelState()`	The model state.
`static ModelProfile`	`of(java.util.function.Function<ModelProfile.Builder,ObjectBuilder<ModelProfile>> fn)`
`ModelStats`	`predict()`	API name: `predict`
`java.lang.String`	`predictor()`	The predictor.
`PredictRequestStats`	`predictRequestStats()`	API name: `predict_request_stats`
`ModelStats`	`register()`	API name: `register`
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`	Serialize this object to JSON.
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupModelProfileDeserializer(ObjectDeserializer<ModelProfile.Builder> op)`
`java.util.List<java.util.List<java.lang.String>>`	`targetWorkerNodes()`	API name: `target_worker_nodes`
`ModelProfile.Builder`	`toBuilder()`	Create a new builder `ToCopyableBuilder` that is initialised with the current state of this object.
`ModelStats`	`train()`	API name: `train`
`ModelStats`	`trainPredict()`	API name: `train_predict`
`ModelStats`	`undeploy()`	API name: `undeploy`
`java.util.List<java.util.List<java.lang.String>>`	`workerNodes()`	API name: `worker_nodes`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<ModelProfile> _DESERIALIZER

Json deserializer for ModelProfile

Method Detail

of

public static ModelProfile of(java.util.function.Function<ModelProfile.Builder,ObjectBuilder<ModelProfile>> fn)

deploy

@Nullable
public final ModelStats deploy()

API name: deploy

execute

@Nullable
public final ModelStats execute()

API name: execute

memorySizeEstimationCpu
```
@Nullable
public final java.lang.Long memorySizeEstimationCpu()
```
The estimated memory size in CPU.
API name: memory_size_estimation_cpu

memorySizeEstimationGpu
```
@Nullable
public final java.lang.Long memorySizeEstimationGpu()
```
The estimated memory size in GPU.
API name: memory_size_estimation_gpu

modelState

@Nullable
public final java.lang.String modelState()

The model state.

API name: model_state

predict

@Nullable
public final ModelStats predict()

API name: predict

predictRequestStats

@Nullable
public final PredictRequestStats predictRequestStats()

API name: predict_request_stats

predictor

@Nullable
public final java.lang.String predictor()

The predictor.

API name: predictor

register

@Nullable
public final ModelStats register()

API name: register

targetWorkerNodes

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

API name: target_worker_nodes

train

@Nullable
public final ModelStats train()

API name: train

trainPredict

@Nullable
public final ModelStats trainPredict()

API name: train_predict

undeploy

@Nullable
public final ModelStats undeploy()

API name: undeploy

workerNodes

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

API name: worker_nodes

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:: serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

toBuilder
```
@Nonnull
public ModelProfile.Builder toBuilder()
```
Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ModelProfile.Builder,ModelProfile>

Returns:

a new builder instance.

builder

@Nonnull
public static ModelProfile.Builder builder()

setupModelProfileDeserializer

protected static void setupModelProfileDeserializer(ObjectDeserializer<ModelProfile.Builder> op)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:: equals in class java.lang.Object

Class ModelProfile

Nested Class Summary

Field Summary