co.elastic.clients.elasticsearch.ml.GetMemoryStatsRequest 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.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.ObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml.get_memory_stats.Request
/**
* Get information about how machine learning jobs and trained models are using
* memory, on each node, both within the JVM heap, and natively, outside of the
* JVM.
*
* @see API
* specification
*/
public class GetMemoryStatsRequest extends RequestBase {
@Nullable
private final Boolean human;
@Nullable
private final Time masterTimeout;
@Nullable
private final String nodeId;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private GetMemoryStatsRequest(Builder builder) {
this.human = builder.human;
this.masterTimeout = builder.masterTimeout;
this.nodeId = builder.nodeId;
this.timeout = builder.timeout;
}
public static GetMemoryStatsRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Specify this query parameter to include the fields with units in the
* response. Otherwise only the _in_bytes sizes are returned in the
* response.
*
* API name: {@code human}
*/
@Nullable
public final Boolean human() {
return this.human;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* The names of particular nodes in the cluster to target. For example,
* nodeId1,nodeId2 or ml:true
*
* API name: {@code node_id}
*/
@Nullable
public final String nodeId() {
return this.nodeId;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetMemoryStatsRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Boolean human;
@Nullable
private Time masterTimeout;
@Nullable
private String nodeId;
@Nullable
private Time timeout;
/**
* Specify this query parameter to include the fields with units in the
* response. Otherwise only the _in_bytes sizes are returned in the
* response.
*
* API name: {@code human}
*/
public final Builder human(@Nullable Boolean value) {
this.human = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(@Nullable Time value) {
this.masterTimeout = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* The names of particular nodes in the cluster to target. For example,
* nodeId1,nodeId2 or ml:true
*
* API name: {@code node_id}
*/
public final Builder nodeId(@Nullable String value) {
this.nodeId = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* Builds a {@link GetMemoryStatsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetMemoryStatsRequest build() {
_checkSingleUse();
return new GetMemoryStatsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.get_memory_stats}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.get_memory_stats",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _nodeId = 1 << 0;
int propsSet = 0;
if (request.nodeId() != null)
propsSet |= _nodeId;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/memory");
buf.append("/_stats");
return buf.toString();
}
if (propsSet == (_nodeId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/memory");
buf.append("/");
SimpleEndpoint.pathEncode(request.nodeId, buf);
buf.append("/_stats");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (request.human != null) {
params.put("human", String.valueOf(request.human));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, GetMemoryStatsResponse._DESERIALIZER);
}