software.amazon.awssdk.services.ec2.model.DescribeCustomerGatewaysResponse 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;
/**
*
* Contains the output of DescribeCustomerGateways.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeCustomerGatewaysResponse extends Ec2Response implements
ToCopyableBuilder {
private static final SdkField> CUSTOMER_GATEWAYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CustomerGateways")
.getter(getter(DescribeCustomerGatewaysResponse::customerGateways))
.setter(setter(Builder::customerGateways))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomerGatewaySet")
.unmarshallLocationName("customerGatewaySet").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CustomerGateway::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CUSTOMER_GATEWAYS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("CustomerGatewaySet", CUSTOMER_GATEWAYS_FIELD);
}
});
private final List customerGateways;
private DescribeCustomerGatewaysResponse(BuilderImpl builder) {
super(builder);
this.customerGateways = builder.customerGateways;
}
/**
* For responses, this returns true if the service returned a value for the CustomerGateways 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 hasCustomerGateways() {
return customerGateways != null && !(customerGateways instanceof SdkAutoConstructList);
}
/**
*
* Information about one or more customer 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 #hasCustomerGateways} method.
*
*
* @return Information about one or more customer gateways.
*/
public final List customerGateways() {
return customerGateways;
}
@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(hasCustomerGateways() ? customerGateways() : null);
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 DescribeCustomerGatewaysResponse)) {
return false;
}
DescribeCustomerGatewaysResponse other = (DescribeCustomerGatewaysResponse) obj;
return hasCustomerGateways() == other.hasCustomerGateways()
&& Objects.equals(customerGateways(), other.customerGateways());
}
/**
* 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("DescribeCustomerGatewaysResponse")
.add("CustomerGateways", hasCustomerGateways() ? customerGateways() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CustomerGateways":
return Optional.ofNullable(clazz.cast(customerGateways()));
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((DescribeCustomerGatewaysResponse) 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 one or more customer gateways.
*
*
* @param customerGateways
* Information about one or more customer gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customerGateways(Collection customerGateways);
/**
*
* Information about one or more customer gateways.
*
*
* @param customerGateways
* Information about one or more customer gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customerGateways(CustomerGateway... customerGateways);
/**
*
* Information about one or more customer gateways.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.CustomerGateway.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ec2.model.CustomerGateway#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ec2.model.CustomerGateway.Builder#build()} is called immediately and
* its result is passed to {@link #customerGateways(List)}.
*
* @param customerGateways
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ec2.model.CustomerGateway.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #customerGateways(java.util.Collection)
*/
Builder customerGateways(Consumer... customerGateways);
}
static final class BuilderImpl extends Ec2Response.BuilderImpl implements Builder {
private List customerGateways = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeCustomerGatewaysResponse model) {
super(model);
customerGateways(model.customerGateways);
}
public final List getCustomerGateways() {
List result = CustomerGatewayListCopier.copyToBuilder(this.customerGateways);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCustomerGateways(Collection customerGateways) {
this.customerGateways = CustomerGatewayListCopier.copyFromBuilder(customerGateways);
}
@Override
public final Builder customerGateways(Collection customerGateways) {
this.customerGateways = CustomerGatewayListCopier.copy(customerGateways);
return this;
}
@Override
@SafeVarargs
public final Builder customerGateways(CustomerGateway... customerGateways) {
customerGateways(Arrays.asList(customerGateways));
return this;
}
@Override
@SafeVarargs
public final Builder customerGateways(Consumer... customerGateways) {
customerGateways(Stream.of(customerGateways).map(c -> CustomerGateway.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public DescribeCustomerGatewaysResponse build() {
return new DescribeCustomerGatewaysResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}