co.elastic.clients.elasticsearch.slm.StopSlmRequest Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.
*/
package co.elastic.clients.elasticsearch.slm;
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 jakarta.json.stream.JsonGenerator;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: slm.stop.Request
/**
* Stop snapshot lifecycle management. Stop all snapshot lifecycle management
* (SLM) operations and the SLM plugin. This API is useful when you are
* performing maintenance on a cluster and need to prevent SLM from performing
* any actions on your data streams or indices. Stopping SLM does not stop any
* snapshots that are in progress. You can manually trigger snapshots with the
* run snapshot lifecycle policy API even if SLM is stopped.
*
* The API returns a response as soon as the request is acknowledged, but the
* plugin might continue to run until in-progress operations complete and it can
* be safely stopped. Use the get snapshot lifecycle management status API to
* see if SLM is running.
*
* @see API
* specification
*/
public class StopSlmRequest extends RequestBase {
@Nullable
private final Time masterTimeout;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private StopSlmRequest(Builder builder) {
this.masterTimeout = builder.masterTimeout;
this.timeout = builder.timeout;
}
public static StopSlmRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The 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.
* To indicate that the request should never timeout, set it to -1.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* The period to wait for a response. If no response is received before the
* timeout expires, the request fails and returns an error. To indicate that the
* request should never timeout, set it to -1.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link StopSlmRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private Time masterTimeout;
@Nullable
private Time timeout;
/**
* The 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.
* To indicate that the request should never timeout, set it to -1.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(@Nullable Time value) {
this.masterTimeout = value;
return this;
}
/**
* The 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.
* To indicate that the request should never timeout, set it to -1.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* The period to wait for a response. If no response is received before the
* timeout expires, the request fails and returns an error. To indicate that the
* request should never timeout, set it to -1.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* The period to wait for a response. If no response is received before the
* timeout expires, the request fails and returns an error. To indicate that the
* request should never timeout, set it to -1.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link StopSlmRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public StopSlmRequest build() {
_checkSingleUse();
return new StopSlmRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code slm.stop}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/slm.stop",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_slm/stop";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), false, StopSlmResponse._DESERIALIZER);
}