software.amazon.awssdk.services.dax.model.SubnetGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dax Show documentation
The AWS Java SDK for Amazon DynamoDB Accelerator (DAX) module holds the client classes that are used for communicating with Amazon DynamoDB Accelerator (DAX).
There is a newer version: 2.29.15
Show newest version
/*
 * 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.dax.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;

/**
 * 
 * Represents the output of one of the following actions:
 * 
 * 
 * 
 * 
 * CreateSubnetGroup
 * 
 * 
 * 
 * 
 * ModifySubnetGroup
 * 
 * 
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class SubnetGroup implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField SUBNET_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("SubnetGroupName").getter(getter(SubnetGroup::subnetGroupName)).setter(setter(Builder::subnetGroupName))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetGroupName").build()).build();

    private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("Description").getter(getter(SubnetGroup::description)).setter(setter(Builder::description))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();

    private static final SdkField VPC_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("VpcId")
            .getter(getter(SubnetGroup::vpcId)).setter(setter(Builder::vpcId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcId").build()).build();

    private static final SdkField> SUBNETS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("Subnets")
            .getter(getter(SubnetGroup::subnets))
            .setter(setter(Builder::subnets))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Subnets").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.SDK_POJO)
                                            .constructor(Subnet::builder)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SUBNET_GROUP_NAME_FIELD,
            DESCRIPTION_FIELD, VPC_ID_FIELD, SUBNETS_FIELD));

    private static final long serialVersionUID = 1L;

    private final String subnetGroupName;

    private final String description;

    private final String vpcId;

    private final List subnets;

    private SubnetGroup(BuilderImpl builder) {
        this.subnetGroupName = builder.subnetGroupName;
        this.description = builder.description;
        this.vpcId = builder.vpcId;
        this.subnets = builder.subnets;
    }

    /**
     * 
     * The name of the subnet group.
     * 
     * 
     * @return The name of the subnet group.
     */
    public final String subnetGroupName() {
        return subnetGroupName;
    }

    /**
     * 
     * The description of the subnet group.
     * 
     * 
     * @return The description of the subnet group.
     */
    public final String description() {
        return description;
    }

    /**
     * 
     * The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
     * 
     * 
     * @return The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
     */
    public final String vpcId() {
        return vpcId;
    }

    /**
     * Returns true if the Subnets property was specified by the sender (it may be empty), or false if the sender did
     * not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
     */
    public final boolean hasSubnets() {
        return subnets != null && !(subnets instanceof SdkAutoConstructList);
    }

    /**
     * 
     * A list of subnets associated with the subnet group.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * You can use {@link #hasSubnets()} to see if a value was sent in this field.
     * 
     * 
     * @return A list of subnets associated with the subnet group.
     */
    public final List subnets() {
        return subnets;
    }

    @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(subnetGroupName());
        hashCode = 31 * hashCode + Objects.hashCode(description());
        hashCode = 31 * hashCode + Objects.hashCode(vpcId());
        hashCode = 31 * hashCode + Objects.hashCode(hasSubnets() ? subnets() : 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 SubnetGroup)) {
            return false;
        }
        SubnetGroup other = (SubnetGroup) obj;
        return Objects.equals(subnetGroupName(), other.subnetGroupName()) && Objects.equals(description(), other.description())
                && Objects.equals(vpcId(), other.vpcId()) && hasSubnets() == other.hasSubnets()
                && Objects.equals(subnets(), other.subnets());
    }

    /**
     * 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("SubnetGroup").add("SubnetGroupName", subnetGroupName()).add("Description", description())
                .add("VpcId", vpcId()).add("Subnets", hasSubnets() ? subnets() : null).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "SubnetGroupName":
            return Optional.ofNullable(clazz.cast(subnetGroupName()));
        case "Description":
            return Optional.ofNullable(clazz.cast(description()));
        case "VpcId":
            return Optional.ofNullable(clazz.cast(vpcId()));
        case "Subnets":
            return Optional.ofNullable(clazz.cast(subnets()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((SubnetGroup) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The name of the subnet group.
         * 
         * 
         * @param subnetGroupName
         *        The name of the subnet group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder subnetGroupName(String subnetGroupName);

        /**
         * 
         * The description of the subnet group.
         * 
         * 
         * @param description
         *        The description of the subnet group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder description(String description);

        /**
         * 
         * The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
         * 
         * 
         * @param vpcId
         *        The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder vpcId(String vpcId);

        /**
         * 
         * A list of subnets associated with the subnet group.
         * 
         * 
         * @param subnets
         *        A list of subnets associated with the subnet group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder subnets(Collection subnets);

        /**
         * 
         * A list of subnets associated with the subnet group.
         * 
         * 
         * @param subnets
         *        A list of subnets associated with the subnet group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder subnets(Subnet... subnets);

        /**
         * 
         * A list of subnets associated with the subnet group.
         * 
         * 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 #subnets(List)}.
         * 
         * @param subnets
         *        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 #subnets(List)
         */
        Builder subnets(Consumer... subnets);
    }

    static final class BuilderImpl implements Builder {
        private String subnetGroupName;

        private String description;

        private String vpcId;

        private List subnets = DefaultSdkAutoConstructList.getInstance();

        private BuilderImpl() {
        }

        private BuilderImpl(SubnetGroup model) {
            subnetGroupName(model.subnetGroupName);
            description(model.description);
            vpcId(model.vpcId);
            subnets(model.subnets);
        }

        public final String getSubnetGroupName() {
            return subnetGroupName;
        }

        @Override
        public final Builder subnetGroupName(String subnetGroupName) {
            this.subnetGroupName = subnetGroupName;
            return this;
        }

        public final void setSubnetGroupName(String subnetGroupName) {
            this.subnetGroupName = subnetGroupName;
        }

        public final String getDescription() {
            return description;
        }

        @Override
        public final Builder description(String description) {
            this.description = description;
            return this;
        }

        public final void setDescription(String description) {
            this.description = description;
        }

        public final String getVpcId() {
            return vpcId;
        }

        @Override
        public final Builder vpcId(String vpcId) {
            this.vpcId = vpcId;
            return this;
        }

        public final void setVpcId(String vpcId) {
            this.vpcId = vpcId;
        }

        public final Collection getSubnets() {
            if (subnets instanceof SdkAutoConstructList) {
                return null;
            }
            return subnets != null ? subnets.stream().map(Subnet::toBuilder).collect(Collectors.toList()) : null;
        }

        @Override
        public final Builder subnets(Collection subnets) {
            this.subnets = SubnetListCopier.copy(subnets);
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder subnets(Subnet... subnets) {
            subnets(Arrays.asList(subnets));
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder subnets(Consumer... subnets) {
            subnets(Stream.of(subnets).map(c -> Subnet.builder().applyMutation(c).build()).collect(Collectors.toList()));
            return this;
        }

        public final void setSubnets(Collection subnets) {
            this.subnets = SubnetListCopier.copyFromBuilder(subnets);
        }

        @Override
        public SubnetGroup build() {
            return new SubnetGroup(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}