com.ibm.cloud.objectstorage.services.s3.transfer.model.UploadResult Maven / Gradle / Ivy
Show all versions of ibm-cos-java-sdk-bundle Show documentation
/*
* Copyright 2010-2017 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 com.ibm.cloud.objectstorage.services.s3.transfer.model;
import com.ibm.cloud.objectstorage.services.s3.transfer.TransferManager;
/**
* Contains information returned by Amazon S3 for a completed upload.
*
* See {@link TransferManager} for more information about creating transfers.
*
* @see TransferManager#upload(String, String, java.io.File)
* @see TransferManager#upload(com.ibm.cloud.objectstorage.services.s3.model.PutObjectRequest)
*/
public class UploadResult {
/** The name of the bucket containing the completed upload. */
private String bucketName;
/** The key by which the object is stored. */
private String key;
/**
* The entity tag identifying the new object. An entity tag is an opaque
* string that changes if and only if an object's data changes.
*/
private String eTag;
/**
* The version ID of the new object, only present if versioning has been
* enabled for the bucket.
*/
private String versionId;
/**
* Returns the name of the bucket containing the uploaded object.
*
* @return The name of the bucket containing the uploaded object.
*/
public String getBucketName() {
return bucketName;
}
/**
* Sets the name of the bucket containing the uploaded object.
*
* @param bucketName
* The name of the bucket containing the uploaded object.
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
* Returns the key by which the newly created object is stored.
*/
public String getKey() {
return key;
}
/**
* Sets the key of the newly created object.
*/
public void setKey(String key) {
this.key = key;
}
/**
* Returns the entity tag identifying the new object. An entity tag is an
* opaque string that changes if and only if an object's data changes.
*
* @return An opaque string that changes if and only if an object's data
* changes.
*/
public String getETag() {
return eTag;
}
/**
* Sets the entity tag identifying the new object. An entity tag is an
* opaque string that changes if and only if an object's data changes.
*
* @param etag
* The entity tag.
*/
public void setETag(String etag) {
this.eTag = etag;
}
/**
* Returns the version ID of the new object. The version ID is only
* set if versioning has been enabled for the bucket.
*
* @return The version ID of the new object.
* The version ID is only
* set if versioning has been enabled for the bucket.
*/
public String getVersionId() {
return versionId;
}
/**
* Sets the version ID of the new object, only present if versioning has
* been enabled for the bucket.
*
* @param versionId
* The version ID of the new object, only present if versioning
* has been enabled for the bucket.
*/
public void setVersionId(String versionId) {
this.versionId = versionId;
}
}