software.amazon.awssdk.services.computeoptimizer.model.S3DestinationConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of computeoptimizer Show documentation
The AWS Java SDK for Compute Optimizer module holds the client classes that are used for communicating with Compute Optimizer.
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.computeoptimizer.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;

/**
 * 
 * Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations
 * export job.
 * 
 * 
 * You must create the destination Amazon S3 bucket for your recommendations export before you create the export job.
 * Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the
 * required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an
 * object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3
 * bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class S3DestinationConfig implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField BUCKET_FIELD = SdkField. builder(MarshallingType.STRING).memberName("bucket")
            .getter(getter(S3DestinationConfig::bucket)).setter(setter(Builder::bucket))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("bucket").build()).build();

    private static final SdkField KEY_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("keyPrefix").getter(getter(S3DestinationConfig::keyPrefix)).setter(setter(Builder::keyPrefix))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("keyPrefix").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
            .asList(BUCKET_FIELD, KEY_PREFIX_FIELD));

    private static final long serialVersionUID = 1L;

    private final String bucket;

    private final String keyPrefix;

    private S3DestinationConfig(BuilderImpl builder) {
        this.bucket = builder.bucket;
        this.keyPrefix = builder.keyPrefix;
    }

    /**
     * 
     * The name of the Amazon S3 bucket to use as the destination for an export job.
     * 
     * 
     * @return The name of the Amazon S3 bucket to use as the destination for an export job.
     */
    public final String bucket() {
        return bucket;
    }

    /**
     * 
     * The Amazon S3 bucket prefix for an export job.
     * 
     * 
     * @return The Amazon S3 bucket prefix for an export job.
     */
    public final String keyPrefix() {
        return keyPrefix;
    }

    @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(bucket());
        hashCode = 31 * hashCode + Objects.hashCode(keyPrefix());
        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 S3DestinationConfig)) {
            return false;
        }
        S3DestinationConfig other = (S3DestinationConfig) obj;
        return Objects.equals(bucket(), other.bucket()) && Objects.equals(keyPrefix(), other.keyPrefix());
    }

    /**
     * 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("S3DestinationConfig").add("Bucket", bucket()).add("KeyPrefix", keyPrefix()).build();
    }

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

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

    private static  Function getter(Function g) {
        return obj -> g.apply((S3DestinationConfig) 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 Amazon S3 bucket to use as the destination for an export job.
         * 
         * 
         * @param bucket
         *        The name of the Amazon S3 bucket to use as the destination for an export job.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder bucket(String bucket);

        /**
         * 
         * The Amazon S3 bucket prefix for an export job.
         * 
         * 
         * @param keyPrefix
         *        The Amazon S3 bucket prefix for an export job.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder keyPrefix(String keyPrefix);
    }

    static final class BuilderImpl implements Builder {
        private String bucket;

        private String keyPrefix;

        private BuilderImpl() {
        }

        private BuilderImpl(S3DestinationConfig model) {
            bucket(model.bucket);
            keyPrefix(model.keyPrefix);
        }

        public final String getBucket() {
            return bucket;
        }

        public final void setBucket(String bucket) {
            this.bucket = bucket;
        }

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

        public final String getKeyPrefix() {
            return keyPrefix;
        }

        public final void setKeyPrefix(String keyPrefix) {
            this.keyPrefix = keyPrefix;
        }

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

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

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