software.amazon.awssdk.services.networkfirewall.model.IPSetReference Maven / Gradle / Ivy

Go to download
/*
 * 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.networkfirewall.model;

import java.io.Serializable;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup
 * or UpdateRuleGroup. An IP set reference is a rule variable that references resources that you create and
 * manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references
 * enable you to dynamically update the contents of your rules. When you create, update, or delete the resource you are
 * referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more
 * information about IP set references in Network Firewall, see Using IP set
 * references in the Network Firewall Developer Guide.
 * 
 * 
 * Network Firewall currently supports Amazon VPC prefix lists and resource groups in IP set references.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class IPSetReference implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField REFERENCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("ReferenceArn").getter(getter(IPSetReference::referenceArn)).setter(setter(Builder::referenceArn))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReferenceArn").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REFERENCE_ARN_FIELD));

    private static final long serialVersionUID = 1L;

    private final String referenceArn;

    private IPSetReference(BuilderImpl builder) {
        this.referenceArn = builder.referenceArn;
    }

    /**
     * 
     * The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
     * 
     * 
     * @return The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
     */
    public final String referenceArn() {
        return referenceArn;
    }

    @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(referenceArn());
        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 IPSetReference)) {
            return false;
        }
        IPSetReference other = (IPSetReference) obj;
        return Objects.equals(referenceArn(), other.referenceArn());
    }

    /**
     * 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("IPSetReference").add("ReferenceArn", referenceArn()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "ReferenceArn":
            return Optional.ofNullable(clazz.cast(referenceArn()));
        default:
            return Optional.empty();
        }
    }

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
         * 
         * 
         * @param referenceArn
         *        The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder referenceArn(String referenceArn);
    }

    static final class BuilderImpl implements Builder {
        private String referenceArn;

        private BuilderImpl() {
        }

        private BuilderImpl(IPSetReference model) {
            referenceArn(model.referenceArn);
        }

        public final String getReferenceArn() {
            return referenceArn;
        }

        public final void setReferenceArn(String referenceArn) {
            this.referenceArn = referenceArn;
        }

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

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

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