co.elastic.clients.elasticsearch.ml.TrainedModelDeploymentStats Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Integer;
import java.lang.Long;
import java.lang.String;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml._types.TrainedModelDeploymentStats
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class TrainedModelDeploymentStats implements JsonpSerializable {
private final TrainedModelDeploymentAllocationStatus allocationStatus;
private final int errorCount;
private final int inferenceCount;
private final int inferenceThreads;
private final String modelId;
private final int modelThreads;
private final TrainedModelDeploymentNodesStats nodes;
private final int queueCapacity;
private final int rejectedExecutionCount;
private final String reason;
private final long startTime;
private final DeploymentState state;
private final int timeoutCount;
// ---------------------------------------------------------------------------------------------
private TrainedModelDeploymentStats(Builder builder) {
this.allocationStatus = ApiTypeHelper.requireNonNull(builder.allocationStatus, this, "allocationStatus");
this.errorCount = ApiTypeHelper.requireNonNull(builder.errorCount, this, "errorCount");
this.inferenceCount = ApiTypeHelper.requireNonNull(builder.inferenceCount, this, "inferenceCount");
this.inferenceThreads = ApiTypeHelper.requireNonNull(builder.inferenceThreads, this, "inferenceThreads");
this.modelId = ApiTypeHelper.requireNonNull(builder.modelId, this, "modelId");
this.modelThreads = ApiTypeHelper.requireNonNull(builder.modelThreads, this, "modelThreads");
this.nodes = ApiTypeHelper.requireNonNull(builder.nodes, this, "nodes");
this.queueCapacity = ApiTypeHelper.requireNonNull(builder.queueCapacity, this, "queueCapacity");
this.rejectedExecutionCount = ApiTypeHelper.requireNonNull(builder.rejectedExecutionCount, this,
"rejectedExecutionCount");
this.reason = ApiTypeHelper.requireNonNull(builder.reason, this, "reason");
this.startTime = ApiTypeHelper.requireNonNull(builder.startTime, this, "startTime");
this.state = ApiTypeHelper.requireNonNull(builder.state, this, "state");
this.timeoutCount = ApiTypeHelper.requireNonNull(builder.timeoutCount, this, "timeoutCount");
}
public static TrainedModelDeploymentStats of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The detailed allocation status for the deployment.
*
* API name: {@code allocation_status}
*/
public final TrainedModelDeploymentAllocationStatus allocationStatus() {
return this.allocationStatus;
}
/**
* Required - The sum of error_count for all nodes in the
* deployment.
*
* API name: {@code error_count}
*/
public final int errorCount() {
return this.errorCount;
}
/**
* Required - The sum of inference_count for all nodes in the
* deployment.
*
* API name: {@code inference_count}
*/
public final int inferenceCount() {
return this.inferenceCount;
}
/**
* Required - The number of threads used by the inference process.
*
* API name: {@code inference_threads}
*/
public final int inferenceThreads() {
return this.inferenceThreads;
}
/**
* Required - The unique identifier for the trained model.
*
* API name: {@code model_id}
*/
public final String modelId() {
return this.modelId;
}
/**
* Required - The number of threads used when sending inference requests to the
* model.
*
* API name: {@code model_threads}
*/
public final int modelThreads() {
return this.modelThreads;
}
/**
* Required - The deployent stats for each node that currently has the model
* allocated.
*
* API name: {@code nodes}
*/
public final TrainedModelDeploymentNodesStats nodes() {
return this.nodes;
}
/**
* Required - The number of inference requests that can be queued before new
* requests are rejected.
*
* API name: {@code queue_capacity}
*/
public final int queueCapacity() {
return this.queueCapacity;
}
/**
* Required - 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: {@code rejected_execution_count}
*/
public final int rejectedExecutionCount() {
return this.rejectedExecutionCount;
}
/**
* Required - The reason for the current deployment state. Usually only
* populated when the model is not deployed to a node.
*
* API name: {@code reason}
*/
public final String reason() {
return this.reason;
}
/**
* Required - The epoch timestamp when the deployment started.
*
* API name: {@code start_time}
*/
public final long startTime() {
return this.startTime;
}
/**
* Required - The overall state of the deployment.
*
* API name: {@code state}
*/
public final DeploymentState state() {
return this.state;
}
/**
* Required - The sum of timeout_count for all nodes in the
* deployment.
*
* API name: {@code timeout_count}
*/
public final int timeoutCount() {
return this.timeoutCount;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
generator.writeKey("allocation_status");
this.allocationStatus.serialize(generator, mapper);
generator.writeKey("error_count");
generator.write(this.errorCount);
generator.writeKey("inference_count");
generator.write(this.inferenceCount);
generator.writeKey("inference_threads");
generator.write(this.inferenceThreads);
generator.writeKey("model_id");
generator.write(this.modelId);
generator.writeKey("model_threads");
generator.write(this.modelThreads);
generator.writeKey("nodes");
this.nodes.serialize(generator, mapper);
generator.writeKey("queue_capacity");
generator.write(this.queueCapacity);
generator.writeKey("rejected_execution_count");
generator.write(this.rejectedExecutionCount);
generator.writeKey("reason");
generator.write(this.reason);
generator.writeKey("start_time");
generator.write(this.startTime);
generator.writeKey("state");
this.state.serialize(generator, mapper);
generator.writeKey("timeout_count");
generator.write(this.timeoutCount);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link TrainedModelDeploymentStats}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private TrainedModelDeploymentAllocationStatus allocationStatus;
private Integer errorCount;
private Integer inferenceCount;
private Integer inferenceThreads;
private String modelId;
private Integer modelThreads;
private TrainedModelDeploymentNodesStats nodes;
private Integer queueCapacity;
private Integer rejectedExecutionCount;
private String reason;
private Long startTime;
private DeploymentState state;
private Integer timeoutCount;
/**
* Required - The detailed allocation status for the deployment.
*
* API name: {@code allocation_status}
*/
public final Builder allocationStatus(TrainedModelDeploymentAllocationStatus value) {
this.allocationStatus = value;
return this;
}
/**
* Required - The detailed allocation status for the deployment.
*
* API name: {@code allocation_status}
*/
public final Builder allocationStatus(
Function> fn) {
return this.allocationStatus(fn.apply(new TrainedModelDeploymentAllocationStatus.Builder()).build());
}
/**
* Required - The sum of error_count for all nodes in the
* deployment.
*
* API name: {@code error_count}
*/
public final Builder errorCount(int value) {
this.errorCount = value;
return this;
}
/**
* Required - The sum of inference_count for all nodes in the
* deployment.
*
* API name: {@code inference_count}
*/
public final Builder inferenceCount(int value) {
this.inferenceCount = value;
return this;
}
/**
* Required - The number of threads used by the inference process.
*
* API name: {@code inference_threads}
*/
public final Builder inferenceThreads(int value) {
this.inferenceThreads = value;
return this;
}
/**
* Required - The unique identifier for the trained model.
*
* API name: {@code model_id}
*/
public final Builder modelId(String value) {
this.modelId = value;
return this;
}
/**
* Required - The number of threads used when sending inference requests to the
* model.
*
* API name: {@code model_threads}
*/
public final Builder modelThreads(int value) {
this.modelThreads = value;
return this;
}
/**
* Required - The deployent stats for each node that currently has the model
* allocated.
*
* API name: {@code nodes}
*/
public final Builder nodes(TrainedModelDeploymentNodesStats value) {
this.nodes = value;
return this;
}
/**
* Required - The deployent stats for each node that currently has the model
* allocated.
*
* API name: {@code nodes}
*/
public final Builder nodes(
Function> fn) {
return this.nodes(fn.apply(new TrainedModelDeploymentNodesStats.Builder()).build());
}
/**
* Required - The number of inference requests that can be queued before new
* requests are rejected.
*
* API name: {@code queue_capacity}
*/
public final Builder queueCapacity(int value) {
this.queueCapacity = value;
return this;
}
/**
* Required - 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: {@code rejected_execution_count}
*/
public final Builder rejectedExecutionCount(int value) {
this.rejectedExecutionCount = value;
return this;
}
/**
* Required - The reason for the current deployment state. Usually only
* populated when the model is not deployed to a node.
*
* API name: {@code reason}
*/
public final Builder reason(String value) {
this.reason = value;
return this;
}
/**
* Required - The epoch timestamp when the deployment started.
*
* API name: {@code start_time}
*/
public final Builder startTime(long value) {
this.startTime = value;
return this;
}
/**
* Required - The overall state of the deployment.
*
* API name: {@code state}
*/
public final Builder state(DeploymentState value) {
this.state = value;
return this;
}
/**
* Required - The sum of timeout_count for all nodes in the
* deployment.
*
* API name: {@code timeout_count}
*/
public final Builder timeoutCount(int value) {
this.timeoutCount = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link TrainedModelDeploymentStats}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public TrainedModelDeploymentStats build() {
_checkSingleUse();
return new TrainedModelDeploymentStats(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link TrainedModelDeploymentStats}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, TrainedModelDeploymentStats::setupTrainedModelDeploymentStatsDeserializer);
protected static void setupTrainedModelDeploymentStatsDeserializer(
ObjectDeserializer op) {
op.add(Builder::allocationStatus, TrainedModelDeploymentAllocationStatus._DESERIALIZER, "allocation_status");
op.add(Builder::errorCount, JsonpDeserializer.integerDeserializer(), "error_count");
op.add(Builder::inferenceCount, JsonpDeserializer.integerDeserializer(), "inference_count");
op.add(Builder::inferenceThreads, JsonpDeserializer.integerDeserializer(), "inference_threads");
op.add(Builder::modelId, JsonpDeserializer.stringDeserializer(), "model_id");
op.add(Builder::modelThreads, JsonpDeserializer.integerDeserializer(), "model_threads");
op.add(Builder::nodes, TrainedModelDeploymentNodesStats._DESERIALIZER, "nodes");
op.add(Builder::queueCapacity, JsonpDeserializer.integerDeserializer(), "queue_capacity");
op.add(Builder::rejectedExecutionCount, JsonpDeserializer.integerDeserializer(), "rejected_execution_count");
op.add(Builder::reason, JsonpDeserializer.stringDeserializer(), "reason");
op.add(Builder::startTime, JsonpDeserializer.longDeserializer(), "start_time");
op.add(Builder::state, DeploymentState._DESERIALIZER, "state");
op.add(Builder::timeoutCount, JsonpDeserializer.integerDeserializer(), "timeout_count");
}
}