co.elastic.clients.elasticsearch.ilm.MigrateToDataTiersRequest 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.ilm;
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.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
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.lang.Boolean;
import java.lang.String;
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: ilm.migrate_to_data_tiers.Request
/**
* Migrate to data tiers routing. Switch the indices, ILM policies, and legacy,
* composable, and component templates from using custom node attributes and
* attribute-based allocation filters to using data tiers. Optionally, delete
* one legacy index template. Using node roles enables ILM to automatically move
* the indices between data tiers.
*
* Migrating away from custom node attributes routing can be manually performed.
* This API provides an automated way of performing three out of the four manual
* steps listed in the migration guide:
*
* - Stop setting the custom hot attribute on new indices.
* - Remove custom allocation settings from existing ILM policies.
* - Replace custom allocation settings from existing indices with the
* corresponding tier preference.
*
*
* ILM must be stopped before performing the migration. Use the stop ILM and get
* ILM status APIs to wait until the reported operation mode is
* STOPPED.
*
* @see API
* specification
*/
@JsonpDeserializable
public class MigrateToDataTiersRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean dryRun;
@Nullable
private final String legacyTemplateToDelete;
@Nullable
private final Time masterTimeout;
@Nullable
private final String nodeAttribute;
// ---------------------------------------------------------------------------------------------
private MigrateToDataTiersRequest(Builder builder) {
this.dryRun = builder.dryRun;
this.legacyTemplateToDelete = builder.legacyTemplateToDelete;
this.masterTimeout = builder.masterTimeout;
this.nodeAttribute = builder.nodeAttribute;
}
public static MigrateToDataTiersRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If true, simulates the migration from node attributes based allocation
* filters to data tiers, but does not perform the migration. This provides a
* way to retrieve the indices and ILM policies that need to be migrated.
*
* API name: {@code dry_run}
*/
@Nullable
public final Boolean dryRun() {
return this.dryRun;
}
/**
* API name: {@code legacy_template_to_delete}
*/
@Nullable
public final String legacyTemplateToDelete() {
return this.legacyTemplateToDelete;
}
/**
* 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.
* It can also be set to -1 to indicate that the request should
* never timeout.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* API name: {@code node_attribute}
*/
@Nullable
public final String nodeAttribute() {
return this.nodeAttribute;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.legacyTemplateToDelete != null) {
generator.writeKey("legacy_template_to_delete");
generator.write(this.legacyTemplateToDelete);
}
if (this.nodeAttribute != null) {
generator.writeKey("node_attribute");
generator.write(this.nodeAttribute);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link MigrateToDataTiersRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean dryRun;
@Nullable
private String legacyTemplateToDelete;
@Nullable
private Time masterTimeout;
@Nullable
private String nodeAttribute;
/**
* If true, simulates the migration from node attributes based allocation
* filters to data tiers, but does not perform the migration. This provides a
* way to retrieve the indices and ILM policies that need to be migrated.
*
* API name: {@code dry_run}
*/
public final Builder dryRun(@Nullable Boolean value) {
this.dryRun = value;
return this;
}
/**
* API name: {@code legacy_template_to_delete}
*/
public final Builder legacyTemplateToDelete(@Nullable String value) {
this.legacyTemplateToDelete = 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.
* It can also be set to -1 to indicate that the request should
* never timeout.
*
* 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.
* It can also be set to -1 to indicate that the request should
* never timeout.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* API name: {@code node_attribute}
*/
public final Builder nodeAttribute(@Nullable String value) {
this.nodeAttribute = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link MigrateToDataTiersRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public MigrateToDataTiersRequest build() {
_checkSingleUse();
return new MigrateToDataTiersRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link MigrateToDataTiersRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, MigrateToDataTiersRequest::setupMigrateToDataTiersRequestDeserializer);
protected static void setupMigrateToDataTiersRequestDeserializer(
ObjectDeserializer op) {
op.add(Builder::legacyTemplateToDelete, JsonpDeserializer.stringDeserializer(), "legacy_template_to_delete");
op.add(Builder::nodeAttribute, JsonpDeserializer.stringDeserializer(), "node_attribute");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ilm.migrate_to_data_tiers}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ilm.migrate_to_data_tiers",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_ilm/migrate_to_data_tiers";
},
// 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.dryRun != null) {
params.put("dry_run", String.valueOf(request.dryRun));
}
return params;
}, SimpleEndpoint.emptyMap(), true, MigrateToDataTiersResponse._DESERIALIZER);
}