co.elastic.clients.elasticsearch.ml.GetTrainedModelsRequest Maven / Gradle / Ivy
/*
* 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.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.Integer;
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_trained_models.Request
/**
* Retrieves configuration information for a trained model.
*
* @see API
* specification
*/
public class GetTrainedModelsRequest extends RequestBase {
@Nullable
private final Boolean allowNoMatch;
@Nullable
private final Boolean decompressDefinition;
@Nullable
private final Boolean excludeGenerated;
@Nullable
private final Integer from;
@Nullable
private final Include include;
@Nullable
private final String modelId;
@Nullable
private final Integer size;
@Nullable
private final String tags;
// ---------------------------------------------------------------------------------------------
private GetTrainedModelsRequest(Builder builder) {
this.allowNoMatch = builder.allowNoMatch;
this.decompressDefinition = builder.decompressDefinition;
this.excludeGenerated = builder.excludeGenerated;
this.from = builder.from;
this.include = builder.include;
this.modelId = builder.modelId;
this.size = builder.size;
this.tags = builder.tags;
}
public static GetTrainedModelsRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Specifies what to do when the request:
*
* - Contains wildcard expressions and there are no models that match.
* - Contains the _all string or no identifiers and there are no matches.
* - Contains wildcard expressions and there are only partial matches.
*
*
* If true, it returns an empty array when there are no matches and the subset
* of results when there are partial matches.
*
* API name: {@code allow_no_match}
*/
@Nullable
public final Boolean allowNoMatch() {
return this.allowNoMatch;
}
/**
* Specifies whether the included model definition should be returned as a JSON
* map (true) or in a custom compressed format (false).
*
* API name: {@code decompress_definition}
*/
@Nullable
public final Boolean decompressDefinition() {
return this.decompressDefinition;
}
/**
* Indicates if certain fields should be removed from the configuration on
* retrieval. This allows the configuration to be in an acceptable format to be
* retrieved and then added to another cluster.
*
* API name: {@code exclude_generated}
*/
@Nullable
public final Boolean excludeGenerated() {
return this.excludeGenerated;
}
/**
* Skips the specified number of models.
*
* API name: {@code from}
*/
@Nullable
public final Integer from() {
return this.from;
}
/**
* A comma delimited string of optional fields to include in the response body.
*
* API name: {@code include}
*/
@Nullable
public final Include include() {
return this.include;
}
/**
* The unique identifier of the trained model.
*
* API name: {@code model_id}
*/
@Nullable
public final String modelId() {
return this.modelId;
}
/**
* Specifies the maximum number of models to obtain.
*
* API name: {@code size}
*/
@Nullable
public final Integer size() {
return this.size;
}
/**
* A comma delimited string of tags. A trained model can have many tags, or
* none. When supplied, only trained models that contain all the supplied tags
* are returned.
*
* API name: {@code tags}
*/
@Nullable
public final String tags() {
return this.tags;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetTrainedModelsRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Boolean allowNoMatch;
@Nullable
private Boolean decompressDefinition;
@Nullable
private Boolean excludeGenerated;
@Nullable
private Integer from;
@Nullable
private Include include;
@Nullable
private String modelId;
@Nullable
private Integer size;
@Nullable
private String tags;
/**
* Specifies what to do when the request:
*
* - Contains wildcard expressions and there are no models that match.
* - Contains the _all string or no identifiers and there are no matches.
* - Contains wildcard expressions and there are only partial matches.
*
*
* If true, it returns an empty array when there are no matches and the subset
* of results when there are partial matches.
*
* API name: {@code allow_no_match}
*/
public final Builder allowNoMatch(@Nullable Boolean value) {
this.allowNoMatch = value;
return this;
}
/**
* Specifies whether the included model definition should be returned as a JSON
* map (true) or in a custom compressed format (false).
*
* API name: {@code decompress_definition}
*/
public final Builder decompressDefinition(@Nullable Boolean value) {
this.decompressDefinition = value;
return this;
}
/**
* Indicates if certain fields should be removed from the configuration on
* retrieval. This allows the configuration to be in an acceptable format to be
* retrieved and then added to another cluster.
*
* API name: {@code exclude_generated}
*/
public final Builder excludeGenerated(@Nullable Boolean value) {
this.excludeGenerated = value;
return this;
}
/**
* Skips the specified number of models.
*
* API name: {@code from}
*/
public final Builder from(@Nullable Integer value) {
this.from = value;
return this;
}
/**
* A comma delimited string of optional fields to include in the response body.
*
* API name: {@code include}
*/
public final Builder include(@Nullable Include value) {
this.include = value;
return this;
}
/**
* The unique identifier of the trained model.
*
* API name: {@code model_id}
*/
public final Builder modelId(@Nullable String value) {
this.modelId = value;
return this;
}
/**
* Specifies the maximum number of models to obtain.
*
* API name: {@code size}
*/
public final Builder size(@Nullable Integer value) {
this.size = value;
return this;
}
/**
* A comma delimited string of tags. A trained model can have many tags, or
* none. When supplied, only trained models that contain all the supplied tags
* are returned.
*
* API name: {@code tags}
*/
public final Builder tags(@Nullable String value) {
this.tags = value;
return this;
}
/**
* Builds a {@link GetTrainedModelsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetTrainedModelsRequest build() {
_checkSingleUse();
return new GetTrainedModelsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.get_trained_models}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.get_trained_models",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _modelId = 1 << 0;
int propsSet = 0;
if (request.modelId() != null)
propsSet |= _modelId;
if (propsSet == (_modelId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/trained_models");
buf.append("/");
SimpleEndpoint.pathEncode(request.modelId, buf);
return buf.toString();
}
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/trained_models");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.include != null) {
params.put("include", request.include.jsonValue());
}
if (request.size != null) {
params.put("size", String.valueOf(request.size));
}
if (request.decompressDefinition != null) {
params.put("decompress_definition", String.valueOf(request.decompressDefinition));
}
if (request.excludeGenerated != null) {
params.put("exclude_generated", String.valueOf(request.excludeGenerated));
}
if (request.from != null) {
params.put("from", String.valueOf(request.from));
}
if (request.allowNoMatch != null) {
params.put("allow_no_match", String.valueOf(request.allowNoMatch));
}
if (request.tags != null) {
params.put("tags", request.tags);
}
return params;
}, SimpleEndpoint.emptyMap(), false, GetTrainedModelsResponse._DESERIALIZER);
}