co.elastic.clients.elasticsearch.slm.ExecuteLifecycleRequest 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.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
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;
//----------------------------------------------------------------
// 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.execute_lifecycle.Request
/**
* Run a policy. Immediately create a snapshot according to the snapshot
* lifecycle policy without waiting for the scheduled time. The snapshot policy
* is normally applied according to its schedule, but you might want to manually
* run a policy before performing an upgrade or other maintenance.
*
* @see API
* specification
*/
public class ExecuteLifecycleRequest extends RequestBase {
@Nullable
private final Time masterTimeout;
private final String policyId;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private ExecuteLifecycleRequest(Builder builder) {
this.masterTimeout = builder.masterTimeout;
this.policyId = ApiTypeHelper.requireNonNull(builder.policyId, this, "policyId");
this.timeout = builder.timeout;
}
public static ExecuteLifecycleRequest 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.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* Required - The id of the snapshot lifecycle policy to be executed
*
* API name: {@code policy_id}
*/
public final String policyId() {
return this.policyId;
}
/**
* The period to wait for a response. If no response is received before the
* timeout expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ExecuteLifecycleRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Time masterTimeout;
private String policyId;
@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.
*
* 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.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* Required - The id of the snapshot lifecycle policy to be executed
*
* API name: {@code policy_id}
*/
public final Builder policyId(String value) {
this.policyId = 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.
*
* 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.
*
* 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 ExecuteLifecycleRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ExecuteLifecycleRequest build() {
_checkSingleUse();
return new ExecuteLifecycleRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code slm.execute_lifecycle}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/slm.execute_lifecycle",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _policyId = 1 << 0;
int propsSet = 0;
propsSet |= _policyId;
if (propsSet == (_policyId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_slm");
buf.append("/policy");
buf.append("/");
SimpleEndpoint.pathEncode(request.policyId, buf);
buf.append("/_execute");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _policyId = 1 << 0;
int propsSet = 0;
propsSet |= _policyId;
if (propsSet == (_policyId)) {
params.put("policyId", request.policyId);
}
return params;
},
// 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, ExecuteLifecycleResponse._DESERIALIZER);
}