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

com.qcloud.cos.transfer.Upload Maven / Gradle / Ivy

Go to download

A single bundled dependency that includes all service and dependent JARs with third-party libraries relocated to different namespaces.

There is a newer version: 5.6.228
Show newest version
/*
 * Copyright 2010-2019 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.
 
 * According to cos feature, we modify some class,comment, field name, etc.
 */


package com.qcloud.cos.transfer;

import com.qcloud.cos.exception.CosClientException;
import com.qcloud.cos.exception.CosServiceException;
import com.qcloud.cos.exception.PauseException;
import com.qcloud.cos.model.UploadResult;

/**
 * Represents an asynchronous upload to Qcloud COS.
 * 

* See {@link TransferManager} for more information about creating transfers. *

* * @see TransferManager#upload(String, String, java.io.File) * @see TransferManager#upload(com.qcloud.cos.model.PutObjectRequest) */ public interface Upload extends Transfer { /** * Waits for this upload to complete and returns the result of this upload. This is a blocking * call. Be prepared to handle errors when calling this method. Any errors that occurred during * the asynchronous transfer will be re-thrown through this method. * * @return The result of this transfer. * * @throws CosClientException If any errors were encountered in the client while making the * request or handling the response. * @throws CosServiceException If any errors occurred in Qcloud COS while processing the * request. * @throws InterruptedException If this thread is interrupted while waiting for the upload to * complete. */ public UploadResult waitForUploadResult() throws CosClientException, CosServiceException, InterruptedException; /** * Pause the current upload operation and returns the information that can be used to resume the * upload. * * Upload cannot be paused in the following cases. *
    *
  • The data source is an input stream.
  • *
  • Client side encryption is used.
  • *
  • Server Side Encryption with customer provided key is used.
  • *
  • Size of the file being uploaded is less than the * {@link TransferManagerConfiguration#getMultipartUploadThreshold()}.
  • *
* In such cases, aborts the uploads and a PauseFailure exception is thrown * * @return An opaque token that holds some private state and can be used to resume a paused * download operation. * * @throws PauseException If failed to pause the operation. */ public PersistableUpload pause() throws PauseException; /** * Tries to pause the current upload operation and returns the information that can be used to * resume the upload. * * Upload cannot be paused in the following cases. *
    *
  • The data source is an input stream.
  • *
  • Client side encryption is used.
  • *
  • Server Side Encryption with customer provided key is used.
  • *
  • Size of the file being uploaded is less than the * {@link TransferManagerConfiguration#getMultipartUploadThreshold()}.
  • *
* * In such cases, aborts the uploads if forceCancelTransfers is set else No action is taken. * * @param forceCancelTransfers a boolean to forcefully abort the existing uploads if pause * cannot be done. * * @return a result of pause operation. */ public PauseResult tryPause(boolean forceCancelTransfers); /** * Abort the current upload operation. */ public void abort(); /** * if multipart upload failed, whether we can upload again. if true, you can call * getResumeableMultipartUploadId to get upload info. then can resume to upload again.. */ public boolean isResumeableMultipartUploadAfterFailed(); /** * if isResumeableMultipartUploadAfterFailed is true, we can call getResumeableMultipartUploadId * to get upload info. then can resume to upload again.. * * @return the PersistableUpload info if you can upload again, otherwise return null; */ public PersistableUpload getResumeableMultipartUploadId(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy