software.amazon.awssdk.services.autoscaling.model.DetachInstancesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of autoscaling Show documentation
Show all versions of autoscaling Show documentation
The AWS Java SDK for Auto Scaling module holds the client classes that are used for communicating with
Auto Scaling
Service
/*
* 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.autoscaling.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DetachInstancesRequest extends AutoScalingRequest implements
ToCopyableBuilder {
private static final SdkField> INSTANCE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("InstanceIds")
.getter(getter(DetachInstancesRequest::instanceIds))
.setter(setter(Builder::instanceIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField AUTO_SCALING_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AutoScalingGroupName").getter(getter(DetachInstancesRequest::autoScalingGroupName))
.setter(setter(Builder::autoScalingGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AutoScalingGroupName").build())
.build();
private static final SdkField SHOULD_DECREMENT_DESIRED_CAPACITY_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("ShouldDecrementDesiredCapacity")
.getter(getter(DetachInstancesRequest::shouldDecrementDesiredCapacity))
.setter(setter(Builder::shouldDecrementDesiredCapacity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ShouldDecrementDesiredCapacity")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_IDS_FIELD,
AUTO_SCALING_GROUP_NAME_FIELD, SHOULD_DECREMENT_DESIRED_CAPACITY_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("InstanceIds", INSTANCE_IDS_FIELD);
put("AutoScalingGroupName", AUTO_SCALING_GROUP_NAME_FIELD);
put("ShouldDecrementDesiredCapacity", SHOULD_DECREMENT_DESIRED_CAPACITY_FIELD);
}
});
private final List instanceIds;
private final String autoScalingGroupName;
private final Boolean shouldDecrementDesiredCapacity;
private DetachInstancesRequest(BuilderImpl builder) {
super(builder);
this.instanceIds = builder.instanceIds;
this.autoScalingGroupName = builder.autoScalingGroupName;
this.shouldDecrementDesiredCapacity = builder.shouldDecrementDesiredCapacity;
}
/**
* For responses, this returns true if the service returned a value for the InstanceIds 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 hasInstanceIds() {
return instanceIds != null && !(instanceIds instanceof SdkAutoConstructList);
}
/**
*
* The IDs of the instances. You can specify up to 20 instances.
*
*
* 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 #hasInstanceIds} method.
*
*
* @return The IDs of the instances. You can specify up to 20 instances.
*/
public final List instanceIds() {
return instanceIds;
}
/**
*
* The name of the Auto Scaling group.
*
*
* @return The name of the Auto Scaling group.
*/
public final String autoScalingGroupName() {
return autoScalingGroupName;
}
/**
*
* Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances
* detached.
*
*
* @return Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances
* detached.
*/
public final Boolean shouldDecrementDesiredCapacity() {
return shouldDecrementDesiredCapacity;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasInstanceIds() ? instanceIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(autoScalingGroupName());
hashCode = 31 * hashCode + Objects.hashCode(shouldDecrementDesiredCapacity());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DetachInstancesRequest)) {
return false;
}
DetachInstancesRequest other = (DetachInstancesRequest) obj;
return hasInstanceIds() == other.hasInstanceIds() && Objects.equals(instanceIds(), other.instanceIds())
&& Objects.equals(autoScalingGroupName(), other.autoScalingGroupName())
&& Objects.equals(shouldDecrementDesiredCapacity(), other.shouldDecrementDesiredCapacity());
}
/**
* 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("DetachInstancesRequest").add("InstanceIds", hasInstanceIds() ? instanceIds() : null)
.add("AutoScalingGroupName", autoScalingGroupName())
.add("ShouldDecrementDesiredCapacity", shouldDecrementDesiredCapacity()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceIds":
return Optional.ofNullable(clazz.cast(instanceIds()));
case "AutoScalingGroupName":
return Optional.ofNullable(clazz.cast(autoScalingGroupName()));
case "ShouldDecrementDesiredCapacity":
return Optional.ofNullable(clazz.cast(shouldDecrementDesiredCapacity()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DetachInstancesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The IDs of the instances. You can specify up to 20 instances.
*
*
* @param instanceIds
* The IDs of the instances. You can specify up to 20 instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(Collection instanceIds);
/**
*
* The IDs of the instances. You can specify up to 20 instances.
*
*
* @param instanceIds
* The IDs of the instances. You can specify up to 20 instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(String... instanceIds);
/**
*
* The name of the Auto Scaling group.
*
*
* @param autoScalingGroupName
* The name of the Auto Scaling group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder autoScalingGroupName(String autoScalingGroupName);
/**
*
* Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances
* detached.
*
*
* @param shouldDecrementDesiredCapacity
* Indicates whether the Auto Scaling group decrements the desired capacity value by the number of
* instances detached.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AutoScalingRequest.BuilderImpl implements Builder {
private List instanceIds = DefaultSdkAutoConstructList.getInstance();
private String autoScalingGroupName;
private Boolean shouldDecrementDesiredCapacity;
private BuilderImpl() {
}
private BuilderImpl(DetachInstancesRequest model) {
super(model);
instanceIds(model.instanceIds);
autoScalingGroupName(model.autoScalingGroupName);
shouldDecrementDesiredCapacity(model.shouldDecrementDesiredCapacity);
}
public final Collection getInstanceIds() {
if (instanceIds instanceof SdkAutoConstructList) {
return null;
}
return instanceIds;
}
public final void setInstanceIds(Collection instanceIds) {
this.instanceIds = InstanceIdsCopier.copy(instanceIds);
}
@Override
public final Builder instanceIds(Collection instanceIds) {
this.instanceIds = InstanceIdsCopier.copy(instanceIds);
return this;
}
@Override
@SafeVarargs
public final Builder instanceIds(String... instanceIds) {
instanceIds(Arrays.asList(instanceIds));
return this;
}
public final String getAutoScalingGroupName() {
return autoScalingGroupName;
}
public final void setAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
}
@Override
public final Builder autoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
return this;
}
public final Boolean getShouldDecrementDesiredCapacity() {
return shouldDecrementDesiredCapacity;
}
public final void setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) {
this.shouldDecrementDesiredCapacity = shouldDecrementDesiredCapacity;
}
@Override
public final Builder shouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) {
this.shouldDecrementDesiredCapacity = shouldDecrementDesiredCapacity;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DetachInstancesRequest build() {
return new DetachInstancesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}