All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.transfer.s3.model.UploadFileRequest Maven / Gradle / Ivy

Go to download

The S3 Transfer Manager allows customers to easily and optimally transfer objects and directories to and from S3.

There is a newer version: 2.28.4
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.transfer.s3.model;

import static software.amazon.awssdk.utils.Validate.paramNotNull;

import java.io.File;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.NotThreadSafe;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.transfer.s3.S3TransferManager;
import software.amazon.awssdk.transfer.s3.progress.TransferListener;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.Validate;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * Represents the request to upload a local file to an object in S3. For non-file-based uploads, you may use {@link UploadRequest}
 * instead.
 *
 * @see S3TransferManager#uploadFile(UploadFileRequest)
 */
@SdkPublicApi
public final class UploadFileRequest
    implements TransferObjectRequest,
               ToCopyableBuilder {

    private final PutObjectRequest putObjectRequest;
    private final Path source;
    private final List listeners;

    private UploadFileRequest(DefaultBuilder builder) {
        this.putObjectRequest = paramNotNull(builder.putObjectRequest, "putObjectRequest");
        this.source = paramNotNull(builder.source, "source");
        this.listeners = builder.listeners;
    }

    /**
     * @return The {@link PutObjectRequest} request that should be used for the upload
     */
    public PutObjectRequest putObjectRequest() {
        return putObjectRequest;
    }

    /**
     * The {@link Path} containing data to send to the service.
     *
     * @return the request body
     */
    public Path source() {
        return source;
    }

    /**
     * @return the List of transferListeners.
     */
    @Override
    public List transferListeners() {
        return listeners;
    }

    /**
     * Creates a builder that can be used to create a {@link UploadFileRequest}.
     *
     * @see S3TransferManager#uploadFile(UploadFileRequest)
     */
    public static Builder builder() {
        return new DefaultBuilder();
    }

    public static Class serializableBuilderClass() {
        return DefaultBuilder.class;
    }
    
    @Override
    public Builder toBuilder() {
        return new DefaultBuilder(this);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        UploadFileRequest that = (UploadFileRequest) o;

        if (!Objects.equals(putObjectRequest, that.putObjectRequest)) {
            return false;
        }
        if (!Objects.equals(source, that.source)) {
            return false;
        }
        return Objects.equals(listeners, that.listeners);
    }

    @Override
    public int hashCode() {
        int result = putObjectRequest != null ? putObjectRequest.hashCode() : 0;
        result = 31 * result + (source != null ? source.hashCode() : 0);
        result = 31 * result + (listeners != null ? listeners.hashCode() : 0);
        return result;
    }

    @Override
    public String toString() {
        return ToString.builder("UploadFileRequest")
                       .add("putObjectRequest", putObjectRequest)
                       .add("source", source)
                       .add("configuration", listeners)
                       .build();
    }

    /**
     * A builder for a {@link UploadFileRequest}, created with {@link #builder()}
     */
    @SdkPublicApi
    @NotThreadSafe
    public interface Builder extends CopyableBuilder {

        /**
         * The {@link Path} to file containing data to send to the service. File will be read entirely and may be read
         * multiple times in the event of a retry. If the file does not exist or the current user does not have
         * access to read it then an exception will be thrown.
         *
         * @param source the source path
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder source(Path source);

        /**
         * The file containing data to send to the service. File will be read entirely and may be read
         * multiple times in the event of a retry. If the file does not exist or the current user does not have
         * access to read it then an exception will be thrown.
         *
         * @param source the source path
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        default Builder source(File source) {
            Validate.paramNotNull(source, "source");
            return this.source(source.toPath());
        }

        /**
         * Configure the {@link PutObjectRequest} that should be used for the upload
         *
         * @param putObjectRequest the putObjectRequest
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see #putObjectRequest(Consumer)
         */
        Builder putObjectRequest(PutObjectRequest putObjectRequest);

        /**
         * Configure the {@link PutObjectRequest} that should be used for the upload
         *
         * 

* This is a convenience method that creates an instance of the {@link PutObjectRequest} builder avoiding the * need to create one manually via {@link PutObjectRequest#builder()}. * * @param putObjectRequestBuilder the putObjectRequest consumer builder * @return Returns a reference to this object so that method calls can be chained together. * @see #putObjectRequest(PutObjectRequest) */ default Builder putObjectRequest(Consumer putObjectRequestBuilder) { return putObjectRequest(PutObjectRequest.builder() .applyMutation(putObjectRequestBuilder) .build()); } /** * The {@link TransferListener}s that will be notified as part of this request. This method overrides and replaces any * transferListeners that have already been set. Add an optional request override configuration. * * @param transferListeners the collection of transferListeners * @return Returns a reference to this object so that method calls can be chained together. * @return This builder for method chaining. * @see TransferListener */ Builder transferListeners(Collection transferListeners); /** * Add a {@link TransferListener} that will be notified as part of this request. * * @param transferListener the transferListener to add * @return Returns a reference to this object so that method calls can be chained together. * @see TransferListener */ Builder addTransferListener(TransferListener transferListener); } private static class DefaultBuilder implements Builder { private PutObjectRequest putObjectRequest; private Path source; private List listeners; private DefaultBuilder() { } private DefaultBuilder(UploadFileRequest uploadFileRequest) { this.source = uploadFileRequest.source; this.putObjectRequest = uploadFileRequest.putObjectRequest; this.listeners = uploadFileRequest.listeners; } @Override public Builder source(Path source) { this.source = Validate.paramNotNull(source, "source"); return this; } public Path getSource() { return source; } public void setSource(Path source) { source(source); } @Override public Builder putObjectRequest(PutObjectRequest putObjectRequest) { this.putObjectRequest = putObjectRequest; return this; } public PutObjectRequest getPutObjectRequest() { return putObjectRequest; } public void setPutObjectRequest(PutObjectRequest putObjectRequest) { putObjectRequest(putObjectRequest); } @Override public Builder transferListeners(Collection transferListeners) { this.listeners = transferListeners != null ? new ArrayList<>(transferListeners) : null; return this; } @Override public Builder addTransferListener(TransferListener transferListener) { if (listeners == null) { listeners = new ArrayList<>(); } listeners.add(transferListener); return this; } public List getListeners() { return listeners; } public void setListeners(Collection listeners) { transferListeners(listeners); } @Override public UploadFileRequest build() { return new UploadFileRequest(this); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy