software.amazon.awssdk.services.ecr.model.ImageScanningConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ecr Show documentation
The AWS Java SDK for the Amazon EC2 Container Registry holds the client classes that are used for communicating with the Amazon EC2 Container Registry Service
There is a newer version: 2.29.39
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.ecr.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;

/**
 * 
 * The image scanning configuration for a repository.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class ImageScanningConfiguration implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField SCAN_ON_PUSH_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
            .memberName("scanOnPush").getter(getter(ImageScanningConfiguration::scanOnPush)).setter(setter(Builder::scanOnPush))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("scanOnPush").build()).build();

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

    private static final long serialVersionUID = 1L;

    private final Boolean scanOnPush;

    private ImageScanningConfiguration(BuilderImpl builder) {
        this.scanOnPush = builder.scanOnPush;
    }

    /**
     * 
     * The setting that determines whether images are scanned after being pushed to a repository. If set to
     * true, images will be scanned after being pushed. If this parameter is not specified, it will default
     * to false and images will not be scanned unless a scan is manually started with the API_StartImageScan
     * API.
     * 
     * 
     * @return The setting that determines whether images are scanned after being pushed to a repository. If set to
     *         true, images will be scanned after being pushed. If this parameter is not specified, it will
     *         default to false and images will not be scanned unless a scan is manually started with the
     *         
     *         API_StartImageScan API.
     */
    public final Boolean scanOnPush() {
        return scanOnPush;
    }

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

    /**
     * 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("ImageScanningConfiguration").add("ScanOnPush", scanOnPush()).build();
    }

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

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The setting that determines whether images are scanned after being pushed to a repository. If set to
         * true, images will be scanned after being pushed. If this parameter is not specified, it will
         * default to false and images will not be scanned unless a scan is manually started with the API_StartImageScan
         * API.
         * 
         * 
         * @param scanOnPush
         *        The setting that determines whether images are scanned after being pushed to a repository. If set to
         *        true, images will be scanned after being pushed. If this parameter is not specified, it
         *        will default to false and images will not be scanned unless a scan is manually started
         *        with the 
         *        API_StartImageScan API.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder scanOnPush(Boolean scanOnPush);
    }

    static final class BuilderImpl implements Builder {
        private Boolean scanOnPush;

        private BuilderImpl() {
        }

        private BuilderImpl(ImageScanningConfiguration model) {
            scanOnPush(model.scanOnPush);
        }

        public final Boolean getScanOnPush() {
            return scanOnPush;
        }

        public final void setScanOnPush(Boolean scanOnPush) {
            this.scanOnPush = scanOnPush;
        }

        @Override
        public final Builder scanOnPush(Boolean scanOnPush) {
            this.scanOnPush = scanOnPush;
            return this;
        }

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

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