com.ibm.cloud.objectstorage.services.s3.model.CompleteMultipartUploadResult Maven / Gradle / Ivy
Show all versions of ibm-cos-java-sdk-s3 Show documentation
/*
* Copyright 2010-2023 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.model;
import java.io.Serializable;
import java.util.Date;
import com.ibm.cloud.objectstorage.services.s3.internal.ObjectExpirationResult;
import com.ibm.cloud.objectstorage.services.s3.internal.S3RequesterChargedResult;
import com.ibm.cloud.objectstorage.services.s3.internal.SSEResultBase;
/**
* The CompleteMultipartUploadResult contains all the information about the
* CompleteMultipartUpload method.
*/
public class CompleteMultipartUploadResult extends SSEResultBase
implements ObjectExpirationResult, S3RequesterChargedResult, Serializable {
/**
* The name of the bucket that contains the newly created object.
* Does not return the access point ARN or access point alias if used.
*/
private String bucketName;
/** The key by which the object is stored. */
private String key;
/** The URL identifying the new multipart object. */
private String location;
/**
* 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;
/** The time this object expires, or null if it has no expiration */
private Date expirationTime;
/** The expiration rule for this object */
private String expirationTimeRuleId;
/**
* Indicate if the requester is charged for conducting this operation from
* Requester Pays Buckets.
*/
private boolean isRequesterCharged;
/**
* Returns the URL identifying the new multipart object.
*
* @return The URL identifying the new multipart object.
*/
public String getLocation() {
return location;
}
/**
* Sets the URL identifying the new multipart object.
*
* @param location
* The URL identifying the new multipart object.
*/
public void setLocation(String location) {
this.location = location;
}
/**
*
* The name of the bucket that contains the newly created object. Does not return the access point ARN or access
* point alias if used.
*
*
*
* When using this action with an access point, you must direct requests to the access point hostname. The access
* point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
* When using this action with an access point through the Amazon Web Services SDKs, you provide the access point
* ARN in place of the bucket name. For more information about access point ARNs, see Using access points in
* the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @return
* The name of the bucket that contains the newly created object. Does not return the access point ARN or access
* point alias if used.
*
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
* Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
* see What is S3 on
* Outposts in the Amazon S3 User Guide.
*/
public String getBucketName() {
return bucketName;
}
/**
* Sets the name of the bucket containing the completed multipart object.
*
* @param bucketName
* The name of the bucket containing the completed multipart
* object.
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
* Gets 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, only present if versioning has
* been enabled for the bucket.
*
* @return The version ID of the new object, only present 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;
}
/**
* Returns the expiration time for this object, or null if it doesn't expire.
*/
public Date getExpirationTime() {
return expirationTime;
}
/**
* Sets the expiration time for the object.
*
* @param expirationTime
* The expiration time for the object.
*/
public void setExpirationTime(Date expirationTime) {
this.expirationTime = expirationTime;
}
/**
* Returns the {@link BucketLifecycleConfiguration} rule ID for this
* object's expiration, or null if it doesn't expire.
*/
public String getExpirationTimeRuleId() {
return expirationTimeRuleId;
}
/**
* Sets the {@link BucketLifecycleConfiguration} rule ID for this object's
* expiration
*
* @param expirationTimeRuleId
* The rule ID for this object's expiration
*/
public void setExpirationTimeRuleId(String expirationTimeRuleId) {
this.expirationTimeRuleId = expirationTimeRuleId;
}
@Override
public boolean isRequesterCharged() {
return isRequesterCharged;
}
@Override
public void setRequesterCharged(boolean isRequesterCharged) {
this.isRequesterCharged = isRequesterCharged;
}
}