software.amazon.awssdk.services.s3.model.ExistingObjectReplication Maven / Gradle / Ivy

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

import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.core.traits.RequiredTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * Optional configuration to replicate existing source bucket objects.
 * 
 * 
 * 
 * This parameter is no longer supported. To replicate existing objects, see Replicating existing
 * objects with S3 Batch Replication in the Amazon S3 User Guide.
 * 
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class ExistingObjectReplication implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField STATUS_FIELD = SdkField
            . builder(MarshallingType.STRING)
            .memberName("Status")
            .getter(getter(ExistingObjectReplication::statusAsString))
            .setter(setter(Builder::status))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status")
                    .unmarshallLocationName("Status").build(), RequiredTrait.create()).build();

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

    private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();

    private static final long serialVersionUID = 1L;

    private final String status;

    private ExistingObjectReplication(BuilderImpl builder) {
        this.status = builder.status;
    }

    /**
     * 
     * Specifies whether Amazon S3 replicates existing source bucket objects.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #status} will
     * return {@link ExistingObjectReplicationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
     * available from {@link #statusAsString}.
     * 
     * 
     * @return Specifies whether Amazon S3 replicates existing source bucket objects.
     * @see ExistingObjectReplicationStatus
     */
    public final ExistingObjectReplicationStatus status() {
        return ExistingObjectReplicationStatus.fromValue(status);
    }

    /**
     * 
     * Specifies whether Amazon S3 replicates existing source bucket objects.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #status} will
     * return {@link ExistingObjectReplicationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
     * available from {@link #statusAsString}.
     * 
     * 
     * @return Specifies whether Amazon S3 replicates existing source bucket objects.
     * @see ExistingObjectReplicationStatus
     */
    public final String statusAsString() {
        return status;
    }

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

    /**
     * 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("ExistingObjectReplication").add("Status", statusAsString()).build();
    }

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

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

    @Override
    public final Map> sdkFieldNameToField() {
        return SDK_NAME_TO_FIELD;
    }

    private static Map> memberNameToFieldInitializer() {
        Map> map = new HashMap<>();
        map.put("Status", STATUS_FIELD);
        return Collections.unmodifiableMap(map);
    }

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * Specifies whether Amazon S3 replicates existing source bucket objects.
         * 
         * 
         * @param status
         *        Specifies whether Amazon S3 replicates existing source bucket objects.
         * @see ExistingObjectReplicationStatus
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see ExistingObjectReplicationStatus
         */
        Builder status(String status);

        /**
         * 
         * Specifies whether Amazon S3 replicates existing source bucket objects.
         * 
         * 
         * @param status
         *        Specifies whether Amazon S3 replicates existing source bucket objects.
         * @see ExistingObjectReplicationStatus
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see ExistingObjectReplicationStatus
         */
        Builder status(ExistingObjectReplicationStatus status);
    }

    static final class BuilderImpl implements Builder {
        private String status;

        private BuilderImpl() {
        }

        private BuilderImpl(ExistingObjectReplication model) {
            status(model.status);
        }

        public final String getStatus() {
            return status;
        }

        public final void setStatus(String status) {
            this.status = status;
        }

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

        @Override
        public final Builder status(ExistingObjectReplicationStatus status) {
            this.status(status == null ? null : status.toString());
            return this;
        }

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

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

        @Override
        public Map> sdkFieldNameToField() {
            return SDK_NAME_TO_FIELD;
        }
    }
}