software.amazon.awssdk.services.ec2.model.DescribeNatGatewaysResponse Maven / Gradle / Ivy
Show all versions of ec2 Show documentation
/*
* 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.ec2.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 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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeNatGatewaysResponse extends Ec2Response implements
ToCopyableBuilder {
private static final SdkField> NAT_GATEWAYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("NatGateways")
.getter(getter(DescribeNatGatewaysResponse::natGateways))
.setter(setter(Builder::natGateways))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NatGatewaySet")
.unmarshallLocationName("natGatewaySet").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(NatGateway::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NextToken")
.getter(getter(DescribeNatGatewaysResponse::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken")
.unmarshallLocationName("nextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAT_GATEWAYS_FIELD,
NEXT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("NatGatewaySet", NAT_GATEWAYS_FIELD);
put("NextToken", NEXT_TOKEN_FIELD);
}
});
private final List natGateways;
private final String nextToken;
private DescribeNatGatewaysResponse(BuilderImpl builder) {
super(builder);
this.natGateways = builder.natGateways;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the NatGateways 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 hasNatGateways() {
return natGateways != null && !(natGateways instanceof SdkAutoConstructList);
}
/**
*
* Information about the NAT gateways.
*
*
* 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 #hasNatGateways} method.
*
*
* @return Information about the NAT gateways.
*/
public final List natGateways() {
return natGateways;
}
/**
*
* The token to include in another request to get the next page of items. This value is null when there
* are no more items to return.
*
*
* @return The token to include in another request to get the next page of items. This value is null
* when there are no more items to return.
*/
public final String nextToken() {
return nextToken;
}
@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(hasNatGateways() ? natGateways() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
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 DescribeNatGatewaysResponse)) {
return false;
}
DescribeNatGatewaysResponse other = (DescribeNatGatewaysResponse) obj;
return hasNatGateways() == other.hasNatGateways() && Objects.equals(natGateways(), other.natGateways())
&& Objects.equals(nextToken(), other.nextToken());
}
/**
* 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("DescribeNatGatewaysResponse").add("NatGateways", hasNatGateways() ? natGateways() : null)
.add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NatGateways":
return Optional.ofNullable(clazz.cast(natGateways()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
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((DescribeNatGatewaysResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Response.Builder, SdkPojo, CopyableBuilder {
/**
*
* Information about the NAT gateways.
*
*
* @param natGateways
* Information about the NAT gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder natGateways(Collection natGateways);
/**
*
* Information about the NAT gateways.
*
*
* @param natGateways
* Information about the NAT gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder natGateways(NatGateway... natGateways);
/**
*
* Information about the NAT gateways.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.NatGateway.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.ec2.model.NatGateway#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ec2.model.NatGateway.Builder#build()} is called immediately and its
* result is passed to {@link #natGateways(List)}.
*
* @param natGateways
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ec2.model.NatGateway.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #natGateways(java.util.Collection)
*/
Builder natGateways(Consumer... natGateways);
/**
*
* The token to include in another request to get the next page of items. This value is null when
* there are no more items to return.
*
*
* @param nextToken
* The token to include in another request to get the next page of items. This value is null
* when there are no more items to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends Ec2Response.BuilderImpl implements Builder {
private List natGateways = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeNatGatewaysResponse model) {
super(model);
natGateways(model.natGateways);
nextToken(model.nextToken);
}
public final List getNatGateways() {
List result = NatGatewayListCopier.copyToBuilder(this.natGateways);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setNatGateways(Collection natGateways) {
this.natGateways = NatGatewayListCopier.copyFromBuilder(natGateways);
}
@Override
public final Builder natGateways(Collection natGateways) {
this.natGateways = NatGatewayListCopier.copy(natGateways);
return this;
}
@Override
@SafeVarargs
public final Builder natGateways(NatGateway... natGateways) {
natGateways(Arrays.asList(natGateways));
return this;
}
@Override
@SafeVarargs
public final Builder natGateways(Consumer... natGateways) {
natGateways(Stream.of(natGateways).map(c -> NatGateway.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public DescribeNatGatewaysResponse build() {
return new DescribeNatGatewaysResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}