co.elastic.clients.elasticsearch.ml.UpgradeJobSnapshotRequest 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.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.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml.upgrade_job_snapshot.Request
/**
* Upgrades an anomaly detection model snapshot to the latest major version.
* Over time, older snapshot formats are deprecated and removed. Anomaly
* detection jobs support only snapshots that are from the current or previous
* major version. This API provides a means to upgrade a snapshot to the current
* major version. This aids in preparing the cluster for an upgrade to the next
* major version. Only one snapshot per anomaly detection job can be upgraded at
* a time and the upgraded snapshot cannot be the current snapshot of the
* anomaly detection job.
*
* @see API
* specification
*/
public class UpgradeJobSnapshotRequest extends RequestBase {
private final String jobId;
private final String snapshotId;
@Nullable
private final Time timeout;
@Nullable
private final Boolean waitForCompletion;
// ---------------------------------------------------------------------------------------------
private UpgradeJobSnapshotRequest(Builder builder) {
this.jobId = ApiTypeHelper.requireNonNull(builder.jobId, this, "jobId");
this.snapshotId = ApiTypeHelper.requireNonNull(builder.snapshotId, this, "snapshotId");
this.timeout = builder.timeout;
this.waitForCompletion = builder.waitForCompletion;
}
public static UpgradeJobSnapshotRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final String jobId() {
return this.jobId;
}
/**
* Required - A numerical character string that uniquely identifies the model
* snapshot.
*
* API name: {@code snapshot_id}
*/
public final String snapshotId() {
return this.snapshotId;
}
/**
* Controls the time to wait for the request to complete.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* When true, the API won’t respond until the upgrade is complete. Otherwise, it
* responds as soon as the upgrade task is assigned to a node.
*
* API name: {@code wait_for_completion}
*/
@Nullable
public final Boolean waitForCompletion() {
return this.waitForCompletion;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link UpgradeJobSnapshotRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
private String jobId;
private String snapshotId;
@Nullable
private Time timeout;
@Nullable
private Boolean waitForCompletion;
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final Builder jobId(String value) {
this.jobId = value;
return this;
}
/**
* Required - A numerical character string that uniquely identifies the model
* snapshot.
*
* API name: {@code snapshot_id}
*/
public final Builder snapshotId(String value) {
this.snapshotId = value;
return this;
}
/**
* Controls the time to wait for the request to complete.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Controls the time to wait for the request to complete.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* When true, the API won’t respond until the upgrade is complete. Otherwise, it
* responds as soon as the upgrade task is assigned to a node.
*
* API name: {@code wait_for_completion}
*/
public final Builder waitForCompletion(@Nullable Boolean value) {
this.waitForCompletion = value;
return this;
}
/**
* Builds a {@link UpgradeJobSnapshotRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public UpgradeJobSnapshotRequest build() {
_checkSingleUse();
return new UpgradeJobSnapshotRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.upgrade_job_snapshot}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.upgrade_job_snapshot",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _snapshotId = 1 << 0;
final int _jobId = 1 << 1;
int propsSet = 0;
propsSet |= _snapshotId;
propsSet |= _jobId;
if (propsSet == (_jobId | _snapshotId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/anomaly_detectors");
buf.append("/");
SimpleEndpoint.pathEncode(request.jobId, buf);
buf.append("/model_snapshots");
buf.append("/");
SimpleEndpoint.pathEncode(request.snapshotId, buf);
buf.append("/_upgrade");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.waitForCompletion != null) {
params.put("wait_for_completion", String.valueOf(request.waitForCompletion));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, UpgradeJobSnapshotResponse._DESERIALIZER);
}