co.elastic.clients.elasticsearch.cat.MlJobsRequest 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.cat;
import co.elastic.clients.elasticsearch._types.Bytes;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.TimeUnit;
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.ApiTypeHelper;
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.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
// typedef: cat.ml_jobs.Request
/**
* Returns configuration and usage information for anomaly detection jobs. This
* API returns a maximum of 10,000 jobs. If the Elasticsearch security features
* are enabled, you must have monitor_ml, monitor,
* manage_ml, or manage cluster privileges to use this
* API.
*
* IMPORTANT: cat APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get anomaly detection job statistics API.
*
* @see API
* specification
*/
public class MlJobsRequest extends CatRequestBase {
@Nullable
private final Boolean allowNoMatch;
@Nullable
private final Bytes bytes;
private final List h;
@Nullable
private final String jobId;
private final List s;
@Nullable
private final TimeUnit time;
// ---------------------------------------------------------------------------------------------
private MlJobsRequest(Builder builder) {
this.allowNoMatch = builder.allowNoMatch;
this.bytes = builder.bytes;
this.h = ApiTypeHelper.unmodifiable(builder.h);
this.jobId = builder.jobId;
this.s = ApiTypeHelper.unmodifiable(builder.s);
this.time = builder.time;
}
public static MlJobsRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Specifies what to do when the request:
*
* - Contains wildcard expressions and there are no jobs 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, the API returns an empty jobs array when there are no
* matches and the subset of results when there are partial matches. If
* false, the API returns a 404 status code when there are no
* matches or only partial matches.
*
* API name: {@code allow_no_match}
*/
@Nullable
public final Boolean allowNoMatch() {
return this.allowNoMatch;
}
/**
* The unit used to display byte values.
*
* API name: {@code bytes}
*/
@Nullable
public final Bytes bytes() {
return this.bytes;
}
/**
* Comma-separated list of column names to display.
*
* API name: {@code h}
*/
public final List h() {
return this.h;
}
/**
* Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
@Nullable
public final String jobId() {
return this.jobId;
}
/**
* Comma-separated list of column names or column aliases used to sort the
* response.
*
* API name: {@code s}
*/
public final List s() {
return this.s;
}
/**
* The unit used to display time values.
*
* API name: {@code time}
*/
@Nullable
public final TimeUnit time() {
return this.time;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link MlJobsRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Boolean allowNoMatch;
@Nullable
private Bytes bytes;
@Nullable
private List h;
@Nullable
private String jobId;
@Nullable
private List s;
@Nullable
private TimeUnit time;
/**
* Specifies what to do when the request:
*
* - Contains wildcard expressions and there are no jobs 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, the API returns an empty jobs array when there are no
* matches and the subset of results when there are partial matches. If
* false, the API returns a 404 status code when there are no
* matches or only partial matches.
*
* API name: {@code allow_no_match}
*/
public final Builder allowNoMatch(@Nullable Boolean value) {
this.allowNoMatch = value;
return this;
}
/**
* The unit used to display byte values.
*
* API name: {@code bytes}
*/
public final Builder bytes(@Nullable Bytes value) {
this.bytes = value;
return this;
}
/**
* Comma-separated list of column names to display.
*
* API name: {@code h}
*
* Adds all elements of list to h.
*/
public final Builder h(List list) {
this.h = _listAddAll(this.h, list);
return this;
}
/**
* Comma-separated list of column names to display.
*
* API name: {@code h}
*
* Adds one or more values to h.
*/
public final Builder h(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values) {
this.h = _listAdd(this.h, value, values);
return this;
}
/**
* Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final Builder jobId(@Nullable String value) {
this.jobId = value;
return this;
}
/**
* Comma-separated list of column names or column aliases used to sort the
* response.
*
* API name: {@code s}
*
* Adds all elements of list to s.
*/
public final Builder s(List list) {
this.s = _listAddAll(this.s, list);
return this;
}
/**
* Comma-separated list of column names or column aliases used to sort the
* response.
*
* API name: {@code s}
*
* Adds one or more values to s.
*/
public final Builder s(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values) {
this.s = _listAdd(this.s, value, values);
return this;
}
/**
* The unit used to display time values.
*
* API name: {@code time}
*/
public final Builder time(@Nullable TimeUnit value) {
this.time = value;
return this;
}
/**
* Builds a {@link MlJobsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public MlJobsRequest build() {
_checkSingleUse();
return new MlJobsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code cat.ml_jobs}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/cat.ml_jobs",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _jobId = 1 << 0;
int propsSet = 0;
if (request.jobId() != null)
propsSet |= _jobId;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_cat");
buf.append("/ml");
buf.append("/anomaly_detectors");
return buf.toString();
}
if (propsSet == (_jobId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_cat");
buf.append("/ml");
buf.append("/anomaly_detectors");
buf.append("/");
SimpleEndpoint.pathEncode(request.jobId, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
params.put("format", "json");
if (ApiTypeHelper.isDefined(request.s)) {
params.put("s", request.s.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.bytes != null) {
params.put("bytes", request.bytes.jsonValue());
}
if (ApiTypeHelper.isDefined(request.h)) {
params.put("h", request.h.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.time != null) {
params.put("time", request.time.jsonValue());
}
if (request.allowNoMatch != null) {
params.put("allow_no_match", String.valueOf(request.allowNoMatch));
}
return params;
}, SimpleEndpoint.emptyMap(), false, MlJobsResponse._DESERIALIZER);
}