Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2011-2015 Amazon Technologies, Inc.
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at:
   *
   *    http://aws.amazon.com/apache2.0
   *
  * 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.amazonaws.services.s3.model;
 
 import java.util.Date;
 import java.util.List;
 

Provides options for copying an Amazon S3 object from a source location to a part of a multipart upload.

All CopyPartRequests must specify an upload id, a source bucket and key, along with a destination bucket and key. Beyond that, requests also specify constraints controlling if the copy will be performed or not.

 
 public class CopyPartRequest extends AmazonWebServiceRequest {

    
 
     private String uploadId;

    
 
     private int partNumber;

    
The name of the bucket containing the object to be copied
 
     private String sourceBucketName;

    
The key in the source bucket under which the object to be copied is stored
 
     private String sourceKey;

    
Optional version Id specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

For more information about enabling versioning for a bucket, see AmazonS3#withBucketVersioningConfiguration(withBucketVersioningConfigurationRequest ).

 
     private String sourceVersionId;

    
The name of the bucket to contain the copy of the source object
 
     private String destinationBucketName;

    
The key in the destination bucket under which the source object will be copied
 
     private String destinationKey;


    
Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag matches one of the specified ETag values.
 
     private final List<StringmatchingETagConstraints = new ArrayList<String>();

    
Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag does not match any of the specified ETag constraint values.
 
     private final List<StringnonmatchingEtagConstraints = new ArrayList<String>();

    
Optional field that constrains the copy request to only be executed if the source object has not been modified since the specified date.
    private Date unmodifiedSinceConstraint;

    
Optional field that constrains the copy request to only be executed if the source object has been modified since the specified date.
    private Date modifiedSinceConstraint;

    
Optional field that copies the object starting at the given zero-based byte offset. Used with lastByte
    private Long firstByte;

    
Optional field that copies the object up to and including the given zero-based byte offset. Used with firstByte.
    private Long lastByte;

    
The optional customer-provided server-side encryption key to use to decrypt the source object part being copied.
    private SSECustomerKey sourceSSECustomerKey;

    
The optional customer-provided server-side encryption key to use to encrypt the source object part being copied.
    private SSECustomerKey destinationSSECustomerKey;


    
Returns the ID of the existing, initiated multipart upload with which this new part will be associated.

Returns:
the ID of the existing, initiated multipart upload with which this new part will be associated.
    public String getUploadId() {
        return ;
    }

    
Sets the ID of the existing, initiated multipart upload with which this new part will be associated.

Parameters:
uploadId the ID of the existing, initiated multipart upload with which this new part will be associated.
    public void setUploadId(String uploadId) {
        this. = uploadId;
    }

    
Sets the ID of the existing, initiated multipart upload with which this new part will be associated.

Parameters:
uploadId the ID of the existing, initiated multipart upload with which this new part will be associated. * @return This CopyPartRequest, enabling additional method calls to be chained together.
    public CopyPartRequest withUploadId(String uploadId) {
        this. = uploadId;
        return this;
    }

    
Returns the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

Returns:
the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).
    public int getPartNumber() {
        return ;
    }

    
Sets the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

Parameters:
partNumber the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).
    public void setPartNumber(int partNumber) {
        this. = partNumber;
    }

    
Sets the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

Parameters:
partNumber the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
    public CopyPartRequest withPartNumber(int partNumber) {
        this. = partNumber;
        return this;
    }

    
Gets the name of the bucket containing the source object to be copied.

Returns:
The name of the bucket containing the source object to be copied.
See also:
setSourceBucketName(java.lang.String)
    public String getSourceBucketName() {
        return ;
    }

    
Sets the name of the bucket containing the source object to be copied.

Parameters:
sourceBucketName The name of the bucket containing the source object to be copied.
See also:
getSourceBucketName()
    public void setSourceBucketName(String sourceBucketName) {
        this. = sourceBucketName;
    }

    
Sets the name of the bucket containing the source object to be copied.

Parameters:
sourceBucketName The name of the bucket containing the source object to be copied.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
See also:
getSourceBucketName()
    public CopyPartRequest withSourceBucketName(String sourceBucketName) {
        this. = sourceBucketName;
        return this;
    }

    
Gets the source bucket key under which the source object to be copied is stored.

Returns:
The source bucket key under which the source object to be copied is stored.
See also:
setSourceKey(java.lang.String)
    public String getSourceKey() {
        return ;
    }

    
Sets the source bucket key under which the source object to be copied is stored.

Parameters:
sourceKey The source bucket key under which the source object to be copied is stored.
See also:
setSourceKey(java.lang.String)
    public void setSourceKey(String sourceKey) {
        this. = sourceKey;
    }

    
Sets the source bucket key under which the source object to be copied is stored.

Parameters:
sourceKey The source bucket key under which the source object to be copied is stored.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
See also:
setSourceKey(java.lang.String)
    public CopyPartRequest withSourceKey(String sourceKey) {
        this. = sourceKey;
        return this;
    }

    

Gets the version ID specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

Objects created before enabling versioning or when versioning is suspended are given the default null version ID (see com.amazonaws.services.s3.internal.Constants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

For more information about enabling versioning for a bucket, see com.amazonaws.services.s3.AmazonS3.setBucketVersioningConfiguration(com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest) .

Returns:
The version ID specifying which version of the source object to copy.
See also:
com.amazonaws.services.s3.internal.Constants.NULL_VERSION_ID
setSourceVersionId(java.lang.String)
    public String getSourceVersionId() {
        return ;
    }

    

Sets the optional version ID specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

Objects created before enabling versioning or when versioning is suspended are given the default null version ID (see com.amazonaws.services.s3.internal.Constants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

For more information about enabling versioning for a bucket, see com.amazonaws.services.s3.AmazonS3.setBucketVersioningConfiguration(com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest) .

Parameters:
sourceVersionId The optional version ID specifying which version of the source object to copy.
    public void setSourceVersionId(String sourceVersionId) {
        this. = sourceVersionId;
    }

    

Sets the optional version ID specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

Objects created before enabling versioning or when versioning is suspended are given the default null version ID (see com.amazonaws.services.s3.internal.Constants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

For more information about enabling versioning for a bucket, see com.amazonaws.services.s3.AmazonS3.setBucketVersioningConfiguration(com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest) .

Parameters:
sourceVersionId The optional version ID specifying which version of the source object to copy.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
    public CopyPartRequest withSourceVersionId(String sourceVersionId) {
        this. = sourceVersionId;
        return this;
    }

    
Gets the destination bucket name which will contain the new, copied object.

Returns:
The name of the destination bucket which will contain the new, copied object.
See also:
setDestinationBucketName(java.lang.String)
    public String getDestinationBucketName() {
        return ;
    }

    
Sets the destination bucket name which will contain the new, copied object.

Parameters:
destinationBucketName The name of the destination bucket which will contain the new, copied object.
See also:
getDestinationBucketName()
    public void setDestinationBucketName(String destinationBucketName) {
        this. = destinationBucketName;
    }

    
Sets the name of the destination bucket which will contain the new, copied object and returns this object, enabling additional method calls to be chained together.

Parameters:
destinationBucketName The name of the destination bucket which will contain the new, copied object.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
    public CopyPartRequest withDestinationBucketName(String destinationBucketName) {
        setDestinationBucketName(destinationBucketName);
        return this;
    }

    
Gets the destination bucket key under which the new, copied object will be stored.

Returns:
The destination bucket key under which the new, copied object will be stored.
See also:
setDestinationKey(java.lang.String)
    public String getDestinationKey() {
        return ;
    }

    
Sets the destination bucket key under which the new, copied object will be stored.

Parameters:
destinationKey The destination bucket key under which the new, copied object will be stored.
See also:
getDestinationKey()
    public void setDestinationKey(String destinationKey) {
        this. = destinationKey;
    }

    
Sets the destination bucket key under which the new, copied object will be stored and returns this object, enabling additional method calls can be chained together.

Parameters:
destinationKey The destination bucket key under which the new, copied object will be stored.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
    public CopyPartRequest withDestinationKey(String destinationKey) {
        setDestinationKey(destinationKey);
        return this;
    }


    
Returns the optional start range to copy from the source object.

Returns:
the optional start range to copy from the source object.
    public Long getFirstByte() {
        return ;
    }

    
Sets the optional zero-based byte offset to begin copying the source object.

Parameters:
firstByte the optional zero-based byte offset to begin copying the source object.
    public void setFirstByte(Long firstByte) {
        this. = firstByte;
    }

    
Sets the optional zero-based byte offset to begin copying the source object.

Parameters:
firstByte the optional zero-based byte offset to begin copying the source object.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
    public CopyPartRequest withFirstByte(Long firstByte) {
        this. = firstByte;
        return this;
    }

    
Returns the optional zero-based byte offset to stop copying the source.

Returns:
the optional zero-based byte offset to stop copying the source.
    public Long getLastByte() {
        return ;
    }

    
Sets the optional zero-based byte offset to stop copying the source.
    public void setLastByte(Long lastByte) {
        this. = lastByte;
    }

    
Sets the optional zero-based byte offset to stop copying the source.

Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
    public CopyPartRequest withLastByte(Long lastByte) {
        this. = lastByte;
        return this;
    }

    

Gets the optional list of ETag constraints that, when present, must include a match for the source object's current ETag in order for the copy object request to be executed. Only one ETag in the list needs to match for the request to be executed by Amazon S3.

Matching ETag constraints may be used with the unmodified since constraint, but not with any other type of constraint.

Returns:
The optional list of ETag constraints that when present must include a match for the source object's current ETag in order for this request to be executed.
        return ;
    }

    

Sets the optional list of ETag constraints that, when present, must include a match for the source object's current ETag in order for the copy object request to be executed. If none of the specified ETags match the source object's current ETag, the copy object operation will be aborted. Only one ETag in the list needs to match for the request to be executed by Amazon S3.

Matching ETag constraints may be used with the unmodified since constraint, but not with any other type of constraint.

Parameters:
eTagList The optional list of ETag constraints that must include a match for the source object's current ETag in order for this request to be executed.
    public void setMatchingETagConstraints(List<StringeTagList) {
        this..clear();
        this..addAll(eTagList);
    }

    
        setMatchingETagConstraints(eTagList);
        return this;
    }

    

Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together. Multiple ETag constraints can be added to a request, but one must match the source object's current ETag in order for the copy object request to be executed. If none of the ETag constraints added to this request match the source object's current ETag, the copy object operation will be aborted.

Matching ETag constraints may be used with the unmodified since constraint, but not with any other type of constraint.

Parameters:
eTag The matching ETag constraint to add to this request.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
        this..add(eTag);
        return this;
    }

    

Gets the optional list of ETag constraints that, when present, must not include a match for the source object's current ETag in order for the copy object request to be executed. If any entry in the non-matching ETag constraint list matches the source object's current ETag, this copy request will not be executed by Amazon S3.

Non-matching ETag constraints may be used with the modified since constraint, but not with any other type of constraint.

Returns:
The optional list of ETag constraints that when present must not include a match for the source object's current ETag in order for this request to be executed.
        return ;
    }

    

Sets the optional list of ETag constraints that, when present, must not include a match for the source object's current ETag in order for the copy object request to be executed. If any entry in the non-matching ETag constraint list matches the source object's current ETag, this copy request will not be executed by Amazon S3.

Non-matching ETag constraints may be used with the modified since constraint, but not with any other type of constraint.

Parameters:
eTagList The list of ETag constraints that, when present, must not include a match for the source object's current ETag in order for this request to be executed.
    public void setNonmatchingETagConstraints(List<StringeTagList) {
        this..clear();
        this..addAll(eTagList);
    }

    
        setNonmatchingETagConstraints(eTagList);
        return this;
    }

    

Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together. Multiple ETag constraints can be added to a request, but all ETag constraints must not match the source object's current ETag in order for the copy object request to be executed. If any entry in the non-matching ETag constraint list matches the source object's current ETag, this copy request will not be executed by Amazon S3.

Non-matching ETag constraints may be used with the modified since constraint, but not with any other type of constraint.

Parameters:
eTag The non-matching ETag constraint to add to this request.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
        this..add(eTag);
        return this;
    }

    

Gets the optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.

The unmodified since constraint may be used with matching ETag constraints, but not with any other type of constraint.

Returns:
The optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.
        return ;
    }

    

Sets the optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.

The unmodified constraint may be used with matching ETag constraints, but not with any other type of constraint.

Note that Amazon S3 will ignore any dates occurring in the future.

Parameters:
date The unmodified constraint that restricts this request to executing only if the source object has not been modified after this date.
    public void setUnmodifiedSinceConstraint(Date date) {
        this. = date;
    }

    

Sets the optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date. Returns this object, enabling additional method calls to be chained together.

The unmodified constraint may be used with matching ETag constraints, but not with any other type of constraint.

Note that Amazon S3 will ignore any dates occurring in the future.

Parameters:
date The unmodified constraint that restricts this request to executing only if the source object has not been modified after this date.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
        setUnmodifiedSinceConstraint(date);
        return this;
    }

    

Gets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

The modified constraint may be used with non-matching ETag constraints, but not with any other type of constraint.

Returns:
The optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
    public Date getModifiedSinceConstraint() {
        return ;
    }

    

Sets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

The modified constraint may be used with non-matching ETag constraints, but not with any other type of constraint.

Note that Amazon S3 will ignore any dates occurring in the future.

Parameters:
date The modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
    public void setModifiedSinceConstraint(Date date) {
        this. = date;
    }

    

Sets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date. Returns this object, enabling additional method calls to be chained together.

The modified constraint may be used with non-matching ETag constraints, but not with any other type of constraint.

Note that Amazon S3 will ignore any dates occurring in the future.

Parameters:
date The modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
Returns:
This CopyPartRequest, enabling additional method calls to be chained together.
        setModifiedSinceConstraint(date);
        return this;
    }

    
Returns the optional customer-provided server-side encryption key to use to decrypt the source object part being copied.

Returns:
The optional customer-provided server-side encryption key to use to decrypt the source object part being copied.
        return ;
    }

    
Sets the optional customer-provided server-side encryption key to use to decrypt the source object part being copied.

Parameters:
sseKey The optional customer-provided server-side encryption key to use to decrypt the source object part being copied.
    public void setSourceSSECustomerKey(SSECustomerKey sseKey) {
        this. = sseKey;
    }

    
Sets the optional customer-provided server-side encryption key to use to decrypt the source object part being copied, and returns the updated request object so that additional method calls can be chained together.

Parameters:
sseKey The optional customer-provided server-side encryption key to use to decrypt the source object part being copied.
Returns:
This updated request object so that additional method calls can be chained together.
        setSourceSSECustomerKey(sseKey);
        return this;
    }

    
Returns the optional customer-provided server-side encryption key to use to encrypt the source object part being copied.

Returns:
The optional customer-provided server-side encryption key to use to encrypt the source object part being copied.
        return ;
    }

    
Sets the optional customer-provided server-side encryption key to use to encrypt the source object part being copied.

Parameters:
sseKey The optional customer-provided server-side encryption key to use to encrypt the source object part being copied.
    public void setDestinationSSECustomerKey(SSECustomerKey sseKey) {
        this. = sseKey;
    }

    
Returns the optional customer-provided server-side encryption key to use to encrypt the source object part being copied, and returns the updated request object so that additional method calls can be chained together.

Parameters:
sseKey The optional customer-provided server-side encryption key to use to encrypt the source object part being copied.
Returns:
This updated request object so that additional method calls can be chained together.
        setDestinationSSECustomerKey(sseKey);
        return this;
    }
New to GrepCode? Check out our FAQ X