software.amazon.awssdk.services.opensearch.model.AutoTuneOptionsInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
Show all versions of opensearch Show documentation
The AWS Java SDK for Open Search module holds the client classes that are used for
communicating with Open Search.
/*
* 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.beans.Transient;
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;
/**
*
* The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AutoTuneOptionsInput implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DESIRED_STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DesiredState").getter(getter(AutoTuneOptionsInput::desiredStateAsString))
.setter(setter(Builder::desiredState))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DesiredState").build()).build();
private static final SdkField> MAINTENANCE_SCHEDULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MaintenanceSchedules")
.getter(getter(AutoTuneOptionsInput::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESIRED_STATE_FIELD,
MAINTENANCE_SCHEDULES_FIELD));
private static final long serialVersionUID = 1L;
private final String desiredState;
private final List maintenanceSchedules;
private AutoTuneOptionsInput(BuilderImpl builder) {
this.desiredState = builder.desiredState;
this.maintenanceSchedules = builder.maintenanceSchedules;
}
/**
*
* The Auto-Tune desired state. Valid values are ENABLED and 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 The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
* @see AutoTuneDesiredState
*/
public final AutoTuneDesiredState desiredState() {
return AutoTuneDesiredState.fromValue(desiredState);
}
/**
*
* The Auto-Tune desired state. Valid values are ENABLED and 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 The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
* @see AutoTuneDesiredState
*/
public final String desiredStateAsString() {
return desiredState;
}
/**
* 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);
}
/**
*
* A list of maintenance schedules. See
* Auto-Tune for Amazon OpenSearch Service for more information.
*
*
* 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 A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
*/
public final List maintenanceSchedules() {
return maintenanceSchedules;
}
@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(hasMaintenanceSchedules() ? maintenanceSchedules() : null);
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 AutoTuneOptionsInput)) {
return false;
}
AutoTuneOptionsInput other = (AutoTuneOptionsInput) obj;
return Objects.equals(desiredStateAsString(), other.desiredStateAsString())
&& hasMaintenanceSchedules() == other.hasMaintenanceSchedules()
&& Objects.equals(maintenanceSchedules(), other.maintenanceSchedules());
}
/**
* 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("AutoTuneOptionsInput").add("DesiredState", desiredStateAsString())
.add("MaintenanceSchedules", hasMaintenanceSchedules() ? maintenanceSchedules() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DesiredState":
return Optional.ofNullable(clazz.cast(desiredStateAsString()));
case "MaintenanceSchedules":
return Optional.ofNullable(clazz.cast(maintenanceSchedules()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AutoTuneOptionsInput) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
*
*
* @param desiredState
* The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
* @see AutoTuneDesiredState
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoTuneDesiredState
*/
Builder desiredState(String desiredState);
/**
*
* The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
*
*
* @param desiredState
* The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
* @see AutoTuneDesiredState
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoTuneDesiredState
*/
Builder desiredState(AutoTuneDesiredState desiredState);
/**
*
* A list of maintenance schedules. See
* Auto-Tune for Amazon OpenSearch Service for more information.
*
*
* @param maintenanceSchedules
* A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maintenanceSchedules(Collection maintenanceSchedules);
/**
*
* A list of maintenance schedules. See
* Auto-Tune for Amazon OpenSearch Service for more information.
*
*
* @param maintenanceSchedules
* A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules);
/**
*
* A list of maintenance schedules. See
* Auto-Tune for Amazon OpenSearch Service for more information.
*
* This is a convenience that creates an instance of the {@link List.Builder}
* avoiding the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called
* immediately and its result is passed to {@link #maintenanceSchedules(List)}.
*
* @param maintenanceSchedules
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #maintenanceSchedules(List)
*/
Builder maintenanceSchedules(Consumer... maintenanceSchedules);
}
static final class BuilderImpl implements Builder {
private String desiredState;
private List maintenanceSchedules = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AutoTuneOptionsInput model) {
desiredState(model.desiredState);
maintenanceSchedules(model.maintenanceSchedules);
}
public final String getDesiredState() {
return desiredState;
}
public final void setDesiredState(String desiredState) {
this.desiredState = desiredState;
}
@Override
@Transient
public final Builder desiredState(String desiredState) {
this.desiredState = desiredState;
return this;
}
@Override
@Transient
public final Builder desiredState(AutoTuneDesiredState desiredState) {
this.desiredState(desiredState == null ? null : desiredState.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
@Transient
public final Builder maintenanceSchedules(Collection maintenanceSchedules) {
this.maintenanceSchedules = AutoTuneMaintenanceScheduleListCopier.copy(maintenanceSchedules);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder maintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules) {
maintenanceSchedules(Arrays.asList(maintenanceSchedules));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder maintenanceSchedules(Consumer... maintenanceSchedules) {
maintenanceSchedules(Stream.of(maintenanceSchedules)
.map(c -> AutoTuneMaintenanceSchedule.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public AutoTuneOptionsInput build() {
return new AutoTuneOptionsInput(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy