software.amazon.awssdk.services.opensearch.model.AutoTuneOptions Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.services.opensearch.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon
* OpenSearch Service.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AutoTuneOptions implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DESIRED_STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DesiredState").getter(getter(AutoTuneOptions::desiredStateAsString))
.setter(setter(Builder::desiredState))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DesiredState").build()).build();
private static final SdkField ROLLBACK_ON_DISABLE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RollbackOnDisable").getter(getter(AutoTuneOptions::rollbackOnDisableAsString))
.setter(setter(Builder::rollbackOnDisable))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RollbackOnDisable").build()).build();
private static final SdkField> MAINTENANCE_SCHEDULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MaintenanceSchedules")
.getter(getter(AutoTuneOptions::maintenanceSchedules))
.setter(setter(Builder::maintenanceSchedules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaintenanceSchedules").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AutoTuneMaintenanceSchedule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField USE_OFF_PEAK_WINDOW_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("UseOffPeakWindow").getter(getter(AutoTuneOptions::useOffPeakWindow))
.setter(setter(Builder::useOffPeakWindow))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UseOffPeakWindow").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESIRED_STATE_FIELD,
ROLLBACK_ON_DISABLE_FIELD, MAINTENANCE_SCHEDULES_FIELD, USE_OFF_PEAK_WINDOW_FIELD));
private static final long serialVersionUID = 1L;
private final String desiredState;
private final String rollbackOnDisable;
private final List maintenanceSchedules;
private final Boolean useOffPeakWindow;
private AutoTuneOptions(BuilderImpl builder) {
this.desiredState = builder.desiredState;
this.rollbackOnDisable = builder.rollbackOnDisable;
this.maintenanceSchedules = builder.maintenanceSchedules;
this.useOffPeakWindow = builder.useOffPeakWindow;
}
/**
*
* Whether Auto-Tune is enabled or disabled.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #desiredState} will
* return {@link AutoTuneDesiredState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #desiredStateAsString}.
*
*
* @return Whether Auto-Tune is enabled or disabled.
* @see AutoTuneDesiredState
*/
public final AutoTuneDesiredState desiredState() {
return AutoTuneDesiredState.fromValue(desiredState);
}
/**
*
* Whether Auto-Tune is enabled or disabled.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #desiredState} will
* return {@link AutoTuneDesiredState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #desiredStateAsString}.
*
*
* @return Whether Auto-Tune is enabled or disabled.
* @see AutoTuneDesiredState
*/
public final String desiredStateAsString() {
return desiredState;
}
/**
*
* When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise,
* OpenSearch Service is unable to perform the rollback.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #rollbackOnDisable}
* will return {@link RollbackOnDisable#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #rollbackOnDisableAsString}.
*
*
* @return When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request.
* Otherwise, OpenSearch Service is unable to perform the rollback.
* @see RollbackOnDisable
*/
public final RollbackOnDisable rollbackOnDisable() {
return RollbackOnDisable.fromValue(rollbackOnDisable);
}
/**
*
* When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise,
* OpenSearch Service is unable to perform the rollback.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #rollbackOnDisable}
* will return {@link RollbackOnDisable#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #rollbackOnDisableAsString}.
*
*
* @return When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request.
* Otherwise, OpenSearch Service is unable to perform the rollback.
* @see RollbackOnDisable
*/
public final String rollbackOnDisableAsString() {
return rollbackOnDisable;
}
/**
* For responses, this returns true if the service returned a value for the MaintenanceSchedules property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasMaintenanceSchedules() {
return maintenanceSchedules != null && !(maintenanceSchedules instanceof SdkAutoConstructList);
}
/**
*
* DEPRECATED. Use off-peak window
* instead.
*
*
* A list of maintenance schedules during which Auto-Tune can deploy changes.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasMaintenanceSchedules} method.
*
*
* @return DEPRECATED. Use off-peak
* window instead.
*
* A list of maintenance schedules during which Auto-Tune can deploy changes.
*/
public final List maintenanceSchedules() {
return maintenanceSchedules;
}
/**
*
* Whether to use the domain's off-peak
* window to deploy configuration changes on the domain rather than a maintenance schedule.
*
*
* @return Whether to use the domain's off-peak
* window to deploy configuration changes on the domain rather than a maintenance schedule.
*/
public final Boolean useOffPeakWindow() {
return useOffPeakWindow;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(desiredStateAsString());
hashCode = 31 * hashCode + Objects.hashCode(rollbackOnDisableAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasMaintenanceSchedules() ? maintenanceSchedules() : null);
hashCode = 31 * hashCode + Objects.hashCode(useOffPeakWindow());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AutoTuneOptions)) {
return false;
}
AutoTuneOptions other = (AutoTuneOptions) obj;
return Objects.equals(desiredStateAsString(), other.desiredStateAsString())
&& Objects.equals(rollbackOnDisableAsString(), other.rollbackOnDisableAsString())
&& hasMaintenanceSchedules() == other.hasMaintenanceSchedules()
&& Objects.equals(maintenanceSchedules(), other.maintenanceSchedules())
&& Objects.equals(useOffPeakWindow(), other.useOffPeakWindow());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("AutoTuneOptions").add("DesiredState", desiredStateAsString())
.add("RollbackOnDisable", rollbackOnDisableAsString())
.add("MaintenanceSchedules", hasMaintenanceSchedules() ? maintenanceSchedules() : null)
.add("UseOffPeakWindow", useOffPeakWindow()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DesiredState":
return Optional.ofNullable(clazz.cast(desiredStateAsString()));
case "RollbackOnDisable":
return Optional.ofNullable(clazz.cast(rollbackOnDisableAsString()));
case "MaintenanceSchedules":
return Optional.ofNullable(clazz.cast(maintenanceSchedules()));
case "UseOffPeakWindow":
return Optional.ofNullable(clazz.cast(useOffPeakWindow()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AutoTuneOptions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Whether Auto-Tune is enabled or disabled.
*
*
* @param desiredState
* Whether Auto-Tune is enabled or disabled.
* @see AutoTuneDesiredState
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoTuneDesiredState
*/
Builder desiredState(String desiredState);
/**
*
* Whether Auto-Tune is enabled or disabled.
*
*
* @param desiredState
* Whether Auto-Tune is enabled or disabled.
* @see AutoTuneDesiredState
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoTuneDesiredState
*/
Builder desiredState(AutoTuneDesiredState desiredState);
/**
*
* When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise,
* OpenSearch Service is unable to perform the rollback.
*
*
* @param rollbackOnDisable
* When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request.
* Otherwise, OpenSearch Service is unable to perform the rollback.
* @see RollbackOnDisable
* @return Returns a reference to this object so that method calls can be chained together.
* @see RollbackOnDisable
*/
Builder rollbackOnDisable(String rollbackOnDisable);
/**
*
* When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise,
* OpenSearch Service is unable to perform the rollback.
*
*
* @param rollbackOnDisable
* When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or
* DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify
* DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request.
* Otherwise, OpenSearch Service is unable to perform the rollback.
* @see RollbackOnDisable
* @return Returns a reference to this object so that method calls can be chained together.
* @see RollbackOnDisable
*/
Builder rollbackOnDisable(RollbackOnDisable rollbackOnDisable);
/**
*
* DEPRECATED. Use off-peak window
* instead.
*
*
* A list of maintenance schedules during which Auto-Tune can deploy changes.
*
*
* @param maintenanceSchedules
* DEPRECATED. Use off-peak
* window instead.
*
* A list of maintenance schedules during which Auto-Tune can deploy changes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maintenanceSchedules(Collection maintenanceSchedules);
/**
*
* DEPRECATED. Use off-peak window
* instead.
*
*
* A list of maintenance schedules during which Auto-Tune can deploy changes.
*
*
* @param maintenanceSchedules
* DEPRECATED. Use off-peak
* window instead.
*
* A list of maintenance schedules during which Auto-Tune can deploy changes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules);
/**
*
* DEPRECATED. Use off-peak window
* instead.
*
*
* A list of maintenance schedules during which Auto-Tune can deploy changes.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.opensearch.model.AutoTuneMaintenanceSchedule.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.opensearch.model.AutoTuneMaintenanceSchedule#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.opensearch.model.AutoTuneMaintenanceSchedule.Builder#build()} is
* called immediately and its result is passed to {@link
* #maintenanceSchedules(List)}.
*
* @param maintenanceSchedules
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.opensearch.model.AutoTuneMaintenanceSchedule.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #maintenanceSchedules(java.util.Collection)
*/
Builder maintenanceSchedules(Consumer... maintenanceSchedules);
/**
*
* Whether to use the domain's off-peak
* window to deploy configuration changes on the domain rather than a maintenance schedule.
*
*
* @param useOffPeakWindow
* Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder useOffPeakWindow(Boolean useOffPeakWindow);
}
static final class BuilderImpl implements Builder {
private String desiredState;
private String rollbackOnDisable;
private List maintenanceSchedules = DefaultSdkAutoConstructList.getInstance();
private Boolean useOffPeakWindow;
private BuilderImpl() {
}
private BuilderImpl(AutoTuneOptions model) {
desiredState(model.desiredState);
rollbackOnDisable(model.rollbackOnDisable);
maintenanceSchedules(model.maintenanceSchedules);
useOffPeakWindow(model.useOffPeakWindow);
}
public final String getDesiredState() {
return desiredState;
}
public final void setDesiredState(String desiredState) {
this.desiredState = desiredState;
}
@Override
public final Builder desiredState(String desiredState) {
this.desiredState = desiredState;
return this;
}
@Override
public final Builder desiredState(AutoTuneDesiredState desiredState) {
this.desiredState(desiredState == null ? null : desiredState.toString());
return this;
}
public final String getRollbackOnDisable() {
return rollbackOnDisable;
}
public final void setRollbackOnDisable(String rollbackOnDisable) {
this.rollbackOnDisable = rollbackOnDisable;
}
@Override
public final Builder rollbackOnDisable(String rollbackOnDisable) {
this.rollbackOnDisable = rollbackOnDisable;
return this;
}
@Override
public final Builder rollbackOnDisable(RollbackOnDisable rollbackOnDisable) {
this.rollbackOnDisable(rollbackOnDisable == null ? null : rollbackOnDisable.toString());
return this;
}
public final List getMaintenanceSchedules() {
List result = AutoTuneMaintenanceScheduleListCopier
.copyToBuilder(this.maintenanceSchedules);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMaintenanceSchedules(Collection maintenanceSchedules) {
this.maintenanceSchedules = AutoTuneMaintenanceScheduleListCopier.copyFromBuilder(maintenanceSchedules);
}
@Override
public final Builder maintenanceSchedules(Collection maintenanceSchedules) {
this.maintenanceSchedules = AutoTuneMaintenanceScheduleListCopier.copy(maintenanceSchedules);
return this;
}
@Override
@SafeVarargs
public final Builder maintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules) {
maintenanceSchedules(Arrays.asList(maintenanceSchedules));
return this;
}
@Override
@SafeVarargs
public final Builder maintenanceSchedules(Consumer... maintenanceSchedules) {
maintenanceSchedules(Stream.of(maintenanceSchedules)
.map(c -> AutoTuneMaintenanceSchedule.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Boolean getUseOffPeakWindow() {
return useOffPeakWindow;
}
public final void setUseOffPeakWindow(Boolean useOffPeakWindow) {
this.useOffPeakWindow = useOffPeakWindow;
}
@Override
public final Builder useOffPeakWindow(Boolean useOffPeakWindow) {
this.useOffPeakWindow = useOffPeakWindow;
return this;
}
@Override
public AutoTuneOptions build() {
return new AutoTuneOptions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}