Package co.elastic.clients.elasticsearch.ml

Class TrainedModelDeploymentStats.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<TrainedModelDeploymentStats.Builder>

co.elastic.clients.elasticsearch.ml.TrainedModelDeploymentStats.Builder

All Implemented Interfaces:

WithJson<TrainedModelDeploymentStats.Builder>, ObjectBuilder<TrainedModelDeploymentStats>

Enclosing class:

TrainedModelDeploymentStats

public static class TrainedModelDeploymentStats.Builder
extends WithJsonObjectBuilderBase<TrainedModelDeploymentStats.Builder>
implements ObjectBuilder<TrainedModelDeploymentStats>

Builder for TrainedModelDeploymentStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final TrainedModelDeploymentStats.Builder	adaptiveAllocations(AdaptiveAllocationsSettings value)	API name: adaptive_allocations
final TrainedModelDeploymentStats.Builder	adaptiveAllocations(Function<AdaptiveAllocationsSettings.Builder,ObjectBuilder<AdaptiveAllocationsSettings>> fn)	API name: adaptive_allocations
final TrainedModelDeploymentStats.Builder	allocationStatus(TrainedModelDeploymentAllocationStatus value)	The detailed allocation status for the deployment.
final TrainedModelDeploymentStats.Builder	allocationStatus(Function<TrainedModelDeploymentAllocationStatus.Builder,ObjectBuilder<TrainedModelDeploymentAllocationStatus>> fn)	The detailed allocation status for the deployment.
TrainedModelDeploymentStats	build()	Builds a TrainedModelDeploymentStats.
final TrainedModelDeploymentStats.Builder	cacheSize(String value)	API name: cache_size
final TrainedModelDeploymentStats.Builder	deploymentId(String value)	Required - The unique identifier for the trained model deployment.
final TrainedModelDeploymentStats.Builder	errorCount(Integer value)	The sum of error_count for all nodes in the deployment.
final TrainedModelDeploymentStats.Builder	inferenceCount(Integer value)	The sum of inference_count for all nodes in the deployment.
final TrainedModelDeploymentStats.Builder	modelId(String value)	Required - The unique identifier for the trained model.
final TrainedModelDeploymentStats.Builder	nodes(TrainedModelDeploymentNodesStats value, TrainedModelDeploymentNodesStats... values)	Required - The deployment stats for each node that currently has the model allocated.
final TrainedModelDeploymentStats.Builder	nodes(Function<TrainedModelDeploymentNodesStats.Builder,ObjectBuilder<TrainedModelDeploymentNodesStats>> fn)	Required - The deployment stats for each node that currently has the model allocated.
final TrainedModelDeploymentStats.Builder	nodes(List<TrainedModelDeploymentNodesStats> list)	Required - The deployment stats for each node that currently has the model allocated.
final TrainedModelDeploymentStats.Builder	numberOfAllocations(Integer value)	The number of allocations requested.
final TrainedModelDeploymentStats.Builder	peakThroughputPerMinute(long value)	Required - API name: peak_throughput_per_minute
final TrainedModelDeploymentStats.Builder	priority(TrainingPriority value)	Required - API name: priority
final TrainedModelDeploymentStats.Builder	queueCapacity(Integer value)	The number of inference requests that can be queued before new requests are rejected.
final TrainedModelDeploymentStats.Builder	reason(String value)	The reason for the current deployment state.
final TrainedModelDeploymentStats.Builder	rejectedExecutionCount(Integer value)	The sum of rejected_execution_count for all nodes in the deployment.
protected TrainedModelDeploymentStats.Builder	self()
final TrainedModelDeploymentStats.Builder	startTime(long value)	Required - The epoch timestamp when the deployment started.
final TrainedModelDeploymentStats.Builder	state(DeploymentAssignmentState value)	The overall state of the deployment.
final TrainedModelDeploymentStats.Builder	threadsPerAllocation(Integer value)	The number of threads used be each allocation during inference.
final TrainedModelDeploymentStats.Builder	timeoutCount(Integer value)	The sum of timeout_count for all nodes in the deployment.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

adaptiveAllocations

public final TrainedModelDeploymentStats.Builder adaptiveAllocations(@Nullable
 AdaptiveAllocationsSettings value)

API name: adaptive_allocations

adaptiveAllocations

public final TrainedModelDeploymentStats.Builder adaptiveAllocations(Function<AdaptiveAllocationsSettings.Builder,ObjectBuilder<AdaptiveAllocationsSettings>> fn)

API name: adaptive_allocations

allocationStatus

public final TrainedModelDeploymentStats.Builder allocationStatus(@Nullable
 TrainedModelDeploymentAllocationStatus value)

The detailed allocation status for the deployment.

API name: allocation_status

allocationStatus

public final TrainedModelDeploymentStats.Builder allocationStatus(Function<TrainedModelDeploymentAllocationStatus.Builder,ObjectBuilder<TrainedModelDeploymentAllocationStatus>> fn)

The detailed allocation status for the deployment.

API name: allocation_status

cacheSize

public final TrainedModelDeploymentStats.Builder cacheSize(@Nullable
 String value)

API name: cache_size

deploymentId

public final TrainedModelDeploymentStats.Builder deploymentId(String value)

Required - The unique identifier for the trained model deployment.

API name: deployment_id

errorCount

public final TrainedModelDeploymentStats.Builder errorCount(@Nullable
 Integer value)

The sum of error_count for all nodes in the deployment.

API name: error_count

inferenceCount

public final TrainedModelDeploymentStats.Builder inferenceCount(@Nullable
 Integer value)

The sum of inference_count for all nodes in the deployment.

API name: inference_count

modelId

public final TrainedModelDeploymentStats.Builder modelId(String value)

Required - The unique identifier for the trained model.

API name: model_id

nodes

public final TrainedModelDeploymentStats.Builder nodes(List<TrainedModelDeploymentNodesStats> list)

Required - The deployment stats for each node that currently has the model allocated. In serverless, stats are reported for a single unnamed virtual node.

API name: nodes

Adds all elements of list to nodes.

nodes

public final TrainedModelDeploymentStats.Builder nodes(TrainedModelDeploymentNodesStats value,
 TrainedModelDeploymentNodesStats... values)

Required - The deployment stats for each node that currently has the model allocated. In serverless, stats are reported for a single unnamed virtual node.

API name: nodes

Adds one or more values to nodes.

nodes

public final TrainedModelDeploymentStats.Builder nodes(Function<TrainedModelDeploymentNodesStats.Builder,ObjectBuilder<TrainedModelDeploymentNodesStats>> fn)

Required - The deployment stats for each node that currently has the model allocated. In serverless, stats are reported for a single unnamed virtual node.

API name: nodes

Adds a value to nodes using a builder lambda.

numberOfAllocations

public final TrainedModelDeploymentStats.Builder numberOfAllocations(@Nullable
 Integer value)

The number of allocations requested.

API name: number_of_allocations

peakThroughputPerMinute

public final TrainedModelDeploymentStats.Builder peakThroughputPerMinute(long value)

Required - API name: peak_throughput_per_minute

priority

public final TrainedModelDeploymentStats.Builder priority(TrainingPriority value)

Required - API name: priority

queueCapacity

public final TrainedModelDeploymentStats.Builder queueCapacity(@Nullable
 Integer value)

The number of inference requests that can be queued before new requests are rejected.

API name: queue_capacity

rejectedExecutionCount

public final TrainedModelDeploymentStats.Builder rejectedExecutionCount(@Nullable
 Integer value)

The sum of rejected_execution_count for all nodes in the deployment. Individual nodes reject an inference request if the inference queue is full. The queue size is controlled by the queue_capacity setting in the start trained model deployment API.

API name: rejected_execution_count

reason

public final TrainedModelDeploymentStats.Builder reason(@Nullable
 String value)

The reason for the current deployment state. Usually only populated when the model is not deployed to a node.

API name: reason

startTime

public final TrainedModelDeploymentStats.Builder startTime(long value)

Required - The epoch timestamp when the deployment started.

API name: start_time

state

public final TrainedModelDeploymentStats.Builder state(@Nullable
 DeploymentAssignmentState value)

The overall state of the deployment.

API name: state

threadsPerAllocation

public final TrainedModelDeploymentStats.Builder threadsPerAllocation(@Nullable
 Integer value)

The number of threads used be each allocation during inference.

API name: threads_per_allocation

timeoutCount

public final TrainedModelDeploymentStats.Builder timeoutCount(@Nullable
 Integer value)

The sum of timeout_count for all nodes in the deployment.

API name: timeout_count

self

protected TrainedModelDeploymentStats.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<TrainedModelDeploymentStats.Builder>

build

public TrainedModelDeploymentStats build()

Builds a TrainedModelDeploymentStats.

Specified by:

build in interface ObjectBuilder<TrainedModelDeploymentStats>

Throws:

NullPointerException - if some of the required fields are null.