co.elastic.clients.elasticsearch.ml.GetJobsRequest 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.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: ml.get_jobs.Request
/**
* Retrieves configuration information for anomaly detection jobs. You can get
* information for multiple anomaly detection jobs in a single API request by
* using a group name, a comma-separated list of jobs, or a wildcard expression.
* You can get information for all anomaly detection jobs by using
* _all, by specifying * as the
* <job_id>, or by omitting the <job_id>.
*
* @see API
* specification
*/
public class GetJobsRequest extends RequestBase {
@Nullable
private final Boolean allowNoMatch;
@Nullable
private final Boolean excludeGenerated;
private final List jobId;
// ---------------------------------------------------------------------------------------------
private GetJobsRequest(Builder builder) {
this.allowNoMatch = builder.allowNoMatch;
this.excludeGenerated = builder.excludeGenerated;
this.jobId = ApiTypeHelper.unmodifiable(builder.jobId);
}
public static GetJobsRequest 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.
*
*
* The default value is true, which returns an empty
* jobs array when there are no matches and the subset of results
* when there are partial matches. If this parameter is false, the
* request 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;
}
/**
* 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;
}
/**
* Identifier for the anomaly detection job. It can be a job identifier, a group
* name, or a wildcard expression. If you do not specify one of these options,
* the API returns information for all anomaly detection jobs.
*
* API name: {@code job_id}
*/
public final List jobId() {
return this.jobId;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetJobsRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Boolean allowNoMatch;
@Nullable
private Boolean excludeGenerated;
@Nullable
private List jobId;
/**
* 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.
*
*
* The default value is true, which returns an empty
* jobs array when there are no matches and the subset of results
* when there are partial matches. If this parameter is false, the
* request 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;
}
/**
* 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;
}
/**
* Identifier for the anomaly detection job. It can be a job identifier, a group
* name, or a wildcard expression. If you do not specify one of these options,
* the API returns information for all anomaly detection jobs.
*
* API name: {@code job_id}
*
* Adds all elements of list to jobId.
*/
public final Builder jobId(List list) {
this.jobId = _listAddAll(this.jobId, list);
return this;
}
/**
* Identifier for the anomaly detection job. It can be a job identifier, a group
* name, or a wildcard expression. If you do not specify one of these options,
* the API returns information for all anomaly detection jobs.
*
* API name: {@code job_id}
*
* Adds one or more values to jobId.
*/
public final Builder jobId(String value, String... values) {
this.jobId = _listAdd(this.jobId, value, values);
return this;
}
/**
* Builds a {@link GetJobsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetJobsRequest build() {
_checkSingleUse();
return new GetJobsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.get_jobs}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.get_jobs",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _jobId = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.jobId()))
propsSet |= _jobId;
if (propsSet == (_jobId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/anomaly_detectors");
buf.append("/");
SimpleEndpoint.pathEncode(request.jobId.stream().map(v -> v).collect(Collectors.joining(",")), buf);
return buf.toString();
}
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/anomaly_detectors");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.excludeGenerated != null) {
params.put("exclude_generated", String.valueOf(request.excludeGenerated));
}
if (request.allowNoMatch != null) {
params.put("allow_no_match", String.valueOf(request.allowNoMatch));
}
return params;
}, SimpleEndpoint.emptyMap(), false, GetJobsResponse._DESERIALIZER);
}