com.amazonaws.services.s3.model

## クラス CopyPartRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.s3.model.CopyPartRequest

-     public class CopyPartRequest
      extends AmazonWebServiceRequest

  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.

関連項目:
  `AmazonS3Client#copyObject(com.amazonaws.services.s3.model.CopyPartRequest)`, `AmazonS3Client.initiateMultipartUpload(InitiateMultipartUploadRequest)`, `AmazonS3Client.uploadPart(UploadPartRequest)`, `CopyPartResult`

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `CopyPartRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getDestinationBucketName()` Gets the destination bucket name which will contain the new, copied object.
    `java.lang.String` | `getDestinationKey()` Gets the destination bucket key under which the new, copied object will be stored.
    `java.lang.Long` | `getFirstByte()` Returns the optional start range to copy from the source object.
    `java.lang.Long` | `getLastByte()` Returns the optional zero-based byte offset to stop copying the source.
    `java.util.List<java.lang.String>` | `getMatchingETagConstraints()` 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.
    `java.util.Date` | `getModifiedSinceConstraint()` Gets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
    `java.util.List<java.lang.String>` | `getNonmatchingETagConstraints()` 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.
    `int` | `getPartNumber()` Returns the part number describing this part's position relative to the other parts in the multipart upload.
    `java.lang.String` | `getSourceBucketName()` Gets the name of the bucket containing the source object to be copied.
    `java.lang.String` | `getSourceKey()` Gets the source bucket key under which the source object to be copied is stored.
    `java.lang.String` | `getSourceVersionId()` Gets the version ID specifying which version of the source object to copy.
    `java.util.Date` | `getUnmodifiedSinceConstraint()` Gets the optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.
    `java.lang.String` | `getUploadId()` Returns the ID of the existing, initiated multipart upload with which this new part will be associated.
    `void` | `setDestinationBucketName(java.lang.String destinationBucketName)` Sets the destination bucket name which will contain the new, copied object.
    `void` | `setDestinationKey(java.lang.String destinationKey)` Sets the destination bucket key under which the new, copied object will be stored.
    `void` | `setFirstByte(java.lang.Long firstByte)` Sets the optional zero-based byte offset to begin copying the source object.
    `void` | `setLastByte(java.lang.Long lastByte)` Sets the optional zero-based byte offset to stop copying the source.
    `void` | `setMatchingETagConstraints(java.util.List<java.lang.String> eTagList)` 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.
    `void` | `setModifiedSinceConstraint(java.util.Date date)` Sets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
    `void` | `setNonmatchingETagConstraints(java.util.List<java.lang.String> eTagList)` 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.
    `void` | `setPartNumber(int partNumber)` Sets the part number describing this part's position relative to the other parts in the multipart upload.
    `void` | `setSourceBucketName(java.lang.String sourceBucketName)` Sets the name of the bucket containing the source object to be copied.
    `void` | `setSourceKey(java.lang.String sourceKey)` Sets the source bucket key under which the source object to be copied is stored.
    `void` | `setSourceVersionId(java.lang.String sourceVersionId)` Sets the optional version ID specifying which version of the source object to copy.
    `void` | `setUnmodifiedSinceConstraint(java.util.Date 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.
    `void` | `setUploadId(java.lang.String uploadId)` Sets the ID of the existing, initiated multipart upload with which this new part will be associated.
    `CopyPartRequest` | `withDestinationBucketName(java.lang.String 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.
    `CopyPartRequest` | `withDestinationKey(java.lang.String 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.
    `CopyPartRequest` | `withFirstByte(java.lang.Long firstByte)` Sets the optional zero-based byte offset to begin copying the source object.
    `CopyPartRequest` | `withLastByte(java.lang.Long lastByte)` Sets the optional zero-based byte offset to stop copying the source.
    `CopyPartRequest` | `withMatchingETagConstraint(java.lang.String eTag)` Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together.
    `CopyPartRequest` | `withModifiedSinceConstraint(java.util.Date date)` Sets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
    `CopyPartRequest` | `withNonmatchingETagConstraint(java.lang.String eTag)` Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together.
    `CopyPartRequest` | `withPartNumber(int partNumber)` Sets the part number describing this part's position relative to the other parts in the multipart upload.
    `CopyPartRequest` | `withSourceBucketName(java.lang.String sourceBucketName)` Sets the name of the bucket containing the source object to be copied.
    `CopyPartRequest` | `withSourceKey(java.lang.String sourceKey)` Sets the source bucket key under which the source object to be copied is stored.
    `CopyPartRequest` | `withSourceVersionId(java.lang.String sourceVersionId)` Sets the optional version ID specifying which version of the source object to copy.
    `CopyPartRequest` | `withUnmodifiedSinceConstraint(java.util.Date 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.
    `CopyPartRequest` | `withUploadId(java.lang.String uploadId)` Sets the ID of the existing, initiated multipart upload with which this new part will be associated.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### CopyPartRequest

          public CopyPartRequest()

  - ### メソッドの詳細

    - #### getUploadId

          public java.lang.String getUploadId()

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

    - #### setUploadId

          public void setUploadId(java.lang.String uploadId)

      Sets the ID of the existing, initiated multipart upload with which this new part will be associated.
      パラメータ:
        `uploadId` - the ID of the existing, initiated multipart upload with which this new part will be associated.

    - #### withUploadId

          public CopyPartRequest withUploadId(java.lang.String uploadId)

      Sets the ID of the existing, initiated multipart upload with which this new part will be associated.
      パラメータ:
        `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.

    - #### getPartNumber

          public int getPartNumber()

      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).
      戻り値:
        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).

    - #### setPartNumber

          public void setPartNumber(int 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).
      パラメータ:
        `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).

    - #### withPartNumber

          public CopyPartRequest withPartNumber(int 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).
      パラメータ:
        `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).
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getSourceBucketName

          public java.lang.String getSourceBucketName()

      Gets the name of the bucket containing the source object to be copied.
      戻り値:
        The name of the bucket containing the source object to be copied.
      関連項目:
        `setSourceBucketName(String sourceBucketName)`

    - #### setSourceBucketName

          public void setSourceBucketName(java.lang.String sourceBucketName)

      Sets the name of the bucket containing the source object to be copied.
      パラメータ:
        `sourceBucketName` - The name of the bucket containing the source object to be copied.
      関連項目:
        `getSourceBucketName()`

    - #### withSourceBucketName

          public CopyPartRequest withSourceBucketName(java.lang.String sourceBucketName)

      Sets the name of the bucket containing the source object to be copied.
      パラメータ:
        `sourceBucketName` - The name of the bucket containing the source object to be copied.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getSourceBucketName()`

    - #### getSourceKey

          public java.lang.String getSourceKey()

      Gets the source bucket key under which the source object to be copied is stored.
      戻り値:
        The source bucket key under which the source object to be copied is stored.
      関連項目:
        `setSourceKey(String sourceKey)`

    - #### setSourceKey

          public void setSourceKey(java.lang.String sourceKey)

      Sets the source bucket key under which the source object to be copied is stored.
      パラメータ:
        `sourceKey` - The source bucket key under which the source object to be copied is stored.
      関連項目:
        `setSourceKey(String sourceKey)`

    - #### withSourceKey

          public CopyPartRequest withSourceKey(java.lang.String sourceKey)

      Sets the source bucket key under which the source object to be copied is stored.
      パラメータ:
        `sourceKey` - The source bucket key under which the source object to be copied is stored.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.
      関連項目:
        `setSourceKey(String sourceKey)`

    - #### getSourceVersionId

          public java.lang.String getSourceVersionId()

      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 `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 `AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)` .

      戻り値:
        The version ID specifying which version of the source object to copy.
      関連項目:
        `Constants.NULL_VERSION_ID`, `setSourceVersionId(String sourceVersionId)`

    - #### setSourceVersionId

          public void setSourceVersionId(java.lang.String 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 `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 `AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)` .

      パラメータ:
        `sourceVersionId` - The optional version ID specifying which version of the source object to copy.

    - #### withSourceVersionId

          public CopyPartRequest withSourceVersionId(java.lang.String 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 `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 `AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)` .

      パラメータ:
        `sourceVersionId` - The optional version ID specifying which version of the source object to copy.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getDestinationBucketName

          public java.lang.String getDestinationBucketName()

      Gets the destination bucket name which will contain the new, copied object.
      戻り値:
        The name of the destination bucket which will contain the new, copied object.
      関連項目:
        `setDestinationBucketName(String destinationBucketName)`

    - #### setDestinationBucketName

          public void setDestinationBucketName(java.lang.String destinationBucketName)

      Sets the destination bucket name which will contain the new, copied object.
      パラメータ:
        `destinationBucketName` - The name of the destination bucket which will contain the new, copied object.
      関連項目:
        `getDestinationBucketName()`

    - #### withDestinationBucketName

          public CopyPartRequest withDestinationBucketName(java.lang.String 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.
      パラメータ:
        `destinationBucketName` - The name of the destination bucket which will contain the new, copied object.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getDestinationKey

          public java.lang.String getDestinationKey()

      Gets the destination bucket key under which the new, copied object will be stored.
      戻り値:
        The destination bucket key under which the new, copied object will be stored.
      関連項目:
        `setDestinationKey(String destinationKey)`

    - #### setDestinationKey

          public void setDestinationKey(java.lang.String destinationKey)

      Sets the destination bucket key under which the new, copied object will be stored.
      パラメータ:
        `destinationKey` - The destination bucket key under which the new, copied object will be stored.
      関連項目:
        `getDestinationKey()`

    - #### withDestinationKey

          public CopyPartRequest withDestinationKey(java.lang.String 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.
      パラメータ:
        `destinationKey` - The destination bucket key under which the new, copied object will be stored.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getFirstByte

          public java.lang.Long getFirstByte()

      Returns the optional start range to copy from the source object.
      戻り値:
        the optional start range to copy from the source object.

    - #### setFirstByte

          public void setFirstByte(java.lang.Long firstByte)

      Sets the optional zero-based byte offset to begin copying the source object.
      パラメータ:
        `firstByte` - the optional zero-based byte offset to begin copying the source object.

    - #### withFirstByte

          public CopyPartRequest withFirstByte(java.lang.Long firstByte)

      Sets the optional zero-based byte offset to begin copying the source object.
      パラメータ:
        `firstByte` - the optional zero-based byte offset to begin copying the source object.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getLastByte

          public java.lang.Long getLastByte()

      Returns the optional zero-based byte offset to stop copying the source.
      戻り値:
        the optional zero-based byte offset to stop copying the source.

    - #### setLastByte

          public void setLastByte(java.lang.Long lastByte)

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

    - #### withLastByte

          public CopyPartRequest withLastByte(java.lang.Long lastByte)

      Sets the optional zero-based byte offset to stop copying the source.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getMatchingETagConstraints

          public java.util.List<java.lang.String> getMatchingETagConstraints()

      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.

      戻り値:
        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.

    - #### setMatchingETagConstraints

          public void setMatchingETagConstraints(java.util.List<java.lang.String> eTagList)

      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.

      パラメータ:
        `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.

    - #### withMatchingETagConstraint

          public CopyPartRequest withMatchingETagConstraint(java.lang.String eTag)

      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.

      パラメータ:
        `eTag` - The matching ETag constraint to add to this request.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getNonmatchingETagConstraints

          public java.util.List<java.lang.String> getNonmatchingETagConstraints()

      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.

      戻り値:
        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.

    - #### setNonmatchingETagConstraints

          public void setNonmatchingETagConstraints(java.util.List<java.lang.String> eTagList)

      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.

      パラメータ:
        `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.

    - #### withNonmatchingETagConstraint

          public CopyPartRequest withNonmatchingETagConstraint(java.lang.String eTag)

      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.

      パラメータ:
        `eTag` - The non-matching ETag constraint to add to this request.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getUnmodifiedSinceConstraint

          public java.util.Date getUnmodifiedSinceConstraint()

      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.

      戻り値:
        The optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.

    - #### setUnmodifiedSinceConstraint

          public void setUnmodifiedSinceConstraint(java.util.Date 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.

      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.

      パラメータ:
        `date` - The unmodified constraint that restricts this request to executing only if the source object has not been modified after this date.

    - #### withUnmodifiedSinceConstraint

          public CopyPartRequest withUnmodifiedSinceConstraint(java.util.Date 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.

      パラメータ:
        `date` - The unmodified constraint that restricts this request to executing only if the source object has not been modified after this date.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.

    - #### getModifiedSinceConstraint

          public java.util.Date getModifiedSinceConstraint()

      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.

      戻り値:
        The optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

    - #### setModifiedSinceConstraint

          public void setModifiedSinceConstraint(java.util.Date date)

      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.

      パラメータ:
        `date` - The modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

    - #### withModifiedSinceConstraint

          public CopyPartRequest withModifiedSinceConstraint(java.util.Date 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.

      パラメータ:
        `date` - The modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
      戻り値:
        This `CopyPartRequest`, enabling additional method calls to be chained together.