software.amazon.awssdk.services.securityhub.model.AwsWafv2ActionBlockDetails 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.securityhub.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.Consumer;
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;

/**
 * 
 * Specifies that WAF should block the request and optionally defines additional custom handling for the response to the
 * web request.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class AwsWafv2ActionBlockDetails implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField CUSTOM_RESPONSE_FIELD = SdkField
            . builder(MarshallingType.SDK_POJO).memberName("CustomResponse")
            .getter(getter(AwsWafv2ActionBlockDetails::customResponse)).setter(setter(Builder::customResponse))
            .constructor(AwsWafv2CustomResponseDetails::builder)
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomResponse").build()).build();

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

    private static final long serialVersionUID = 1L;

    private final AwsWafv2CustomResponseDetails customResponse;

    private AwsWafv2ActionBlockDetails(BuilderImpl builder) {
        this.customResponse = builder.customResponse;
    }

    /**
     * 
     * Defines a custom response for the web request. For information, see Customizing web
     * requests and responses in WAF in the WAF Developer Guide..
     * 
     * 
     * @return Defines a custom response for the web request. For information, see Customizing
     *         web requests and responses in WAF in the WAF Developer Guide..
     */
    public final AwsWafv2CustomResponseDetails customResponse() {
        return customResponse;
    }

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

    /**
     * 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("AwsWafv2ActionBlockDetails").add("CustomResponse", customResponse()).build();
    }

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

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * Defines a custom response for the web request. For information, see Customizing web
         * requests and responses in WAF in the WAF Developer Guide..
         * 
         * 
         * @param customResponse
         *        Defines a custom response for the web request. For information, see Customizing web requests and responses in WAF in the WAF Developer Guide..
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder customResponse(AwsWafv2CustomResponseDetails customResponse);

        /**
         * 
         * Defines a custom response for the web request. For information, see Customizing web
         * requests and responses in WAF in the WAF Developer Guide..
         * 
         * This is a convenience method that creates an instance of the {@link AwsWafv2CustomResponseDetails.Builder}
         * avoiding the need to create one manually via {@link AwsWafv2CustomResponseDetails#builder()}.
         *
         * 
         * When the {@link Consumer} completes, {@link AwsWafv2CustomResponseDetails.Builder#build()} is called
         * immediately and its result is passed to {@link #customResponse(AwsWafv2CustomResponseDetails)}.
         * 
         * @param customResponse
         *        a consumer that will call methods on {@link AwsWafv2CustomResponseDetails.Builder}
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see #customResponse(AwsWafv2CustomResponseDetails)
         */
        default Builder customResponse(Consumer customResponse) {
            return customResponse(AwsWafv2CustomResponseDetails.builder().applyMutation(customResponse).build());
        }
    }

    static final class BuilderImpl implements Builder {
        private AwsWafv2CustomResponseDetails customResponse;

        private BuilderImpl() {
        }

        private BuilderImpl(AwsWafv2ActionBlockDetails model) {
            customResponse(model.customResponse);
        }

        public final AwsWafv2CustomResponseDetails.Builder getCustomResponse() {
            return customResponse != null ? customResponse.toBuilder() : null;
        }

        public final void setCustomResponse(AwsWafv2CustomResponseDetails.BuilderImpl customResponse) {
            this.customResponse = customResponse != null ? customResponse.build() : null;
        }

        @Override
        public final Builder customResponse(AwsWafv2CustomResponseDetails customResponse) {
            this.customResponse = customResponse;
            return this;
        }

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

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