java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.UploadPartCopyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UploadPartCopyRequest.Builder,UploadPartCopyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UploadPartCopyRequest
extends S3Request
implements ToCopyableBuilder<UploadPartCopyRequest.Builder,UploadPartCopyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UploadPartCopyRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`bucket()`	Deprecated. Use `destinationBucket()`
`static UploadPartCopyRequest.Builder`	`builder()`
`String`	`copySource()`	Deprecated. The `copySource` parameter has been deprecated in favor of the more user-friendly `sourceBucket`, `sourceKey`, and `sourceVersionId` parameters.
`String`	`copySourceIfMatch()`	Copies the object if its entity tag (ETag) matches the specified tag.
`Instant`	`copySourceIfModifiedSince()`	Copies the object if it has been modified since the specified time.
`String`	`copySourceIfNoneMatch()`	Copies the object if its entity tag (ETag) is different than the specified ETag.
`Instant`	`copySourceIfUnmodifiedSince()`	Copies the object if it hasn't been modified since the specified time.
`String`	`copySourceRange()`	The range of bytes to copy from the source object.
`String`	`copySourceSSECustomerAlgorithm()`	Specifies the algorithm to use when decrypting the source object (for example, AES256).
`String`	`copySourceSSECustomerKey()`	Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
`String`	`copySourceSSECustomerKeyMD5()`	Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
`String`	`destinationBucket()`	The bucket name.
`String`	`destinationKey()`	Object key for which the multipart upload was initiated.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`expectedBucketOwner()`	The account ID of the expected destination bucket owner.
`String`	`expectedSourceBucketOwner()`	The account ID of the expected source bucket owner.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`key()`	Deprecated. Use `destinationKey()`
`Integer`	`partNumber()`	Part number of part being copied.
`RequestPayer`	`requestPayer()`	Returns the value of the RequestPayer property for this object.
`String`	`requestPayerAsString()`	Returns the value of the RequestPayer property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UploadPartCopyRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceBucket()`	The name of the bucket containing the object to copy.
`String`	`sourceKey()`	The key of the object to copy.
`String`	`sourceVersionId()`	Specifies a particular version of the source object to copy.
`String`	`sseCustomerAlgorithm()`	Specifies the algorithm to use to when encrypting the object (for example, AES256).
`String`	`sseCustomerKey()`	Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
`String`	`sseCustomerKeyMD5()`	Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
`UploadPartCopyRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`uploadId()`	Upload ID identifying the multipart upload whose part is being copied.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - copySource
```
@Deprecated
public final String copySource()
```
    Deprecated.
    The copySource parameter has been deprecated in favor of the more user-friendly sourceBucket, sourceKey, and sourceVersionId parameters. The copySource parameter will remain fully functional, but it must not be used in conjunction with its replacement parameters.
    Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
    
    For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.
    
    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.
    
    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
    
    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.
    
    To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.
    Returns:
    
    Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
    
    For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.
    
    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.
    
    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
    
    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key> . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.
    
    To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.
  - copySourceIfMatch
```
public final String copySourceIfMatch()
```
    Copies the object if its entity tag (ETag) matches the specified tag.
    
    Returns:
    
    Copies the object if its entity tag (ETag) matches the specified tag.
  - copySourceIfModifiedSince
```
public final Instant copySourceIfModifiedSince()
```
    Copies the object if it has been modified since the specified time.
    
    Returns:
    
    Copies the object if it has been modified since the specified time.
  - copySourceIfNoneMatch
```
public final String copySourceIfNoneMatch()
```
    Copies the object if its entity tag (ETag) is different than the specified ETag.
    
    Returns:
    
    Copies the object if its entity tag (ETag) is different than the specified ETag.
  - copySourceIfUnmodifiedSince
```
public final Instant copySourceIfUnmodifiedSince()
```
    Copies the object if it hasn't been modified since the specified time.
    
    Returns:
    
    Copies the object if it hasn't been modified since the specified time.
  - copySourceRange
```
public final String copySourceRange()
```
    The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.
    
    Returns:
    
    The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.
  - partNumber
```
public final Integer partNumber()
```
    Part number of part being copied. This is a positive integer between 1 and 10,000.
    
    Returns:
    
    Part number of part being copied. This is a positive integer between 1 and 10,000.
  - uploadId
```
public final String uploadId()
```
    Upload ID identifying the multipart upload whose part is being copied.
    
    Returns:
    
    Upload ID identifying the multipart upload whose part is being copied.
  - sseCustomerAlgorithm
```
public final String sseCustomerAlgorithm()
```
    Specifies the algorithm to use to when encrypting the object (for example, AES256).
    
    Returns:
    
    Specifies the algorithm to use to when encrypting the object (for example, AES256).
  - sseCustomerKey
```
public final String sseCustomerKey()
```
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
    
    Returns:
    
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
  - sseCustomerKeyMD5
```
public final String sseCustomerKeyMD5()
```
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
    
    Returns:
    
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
  - copySourceSSECustomerAlgorithm
```
public final String copySourceSSECustomerAlgorithm()
```
    Specifies the algorithm to use when decrypting the source object (for example, AES256).
    
    Returns:
    
    Specifies the algorithm to use when decrypting the source object (for example, AES256).
  - copySourceSSECustomerKey
```
public final String copySourceSSECustomerKey()
```
    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
    
    Returns:
    
    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
  - copySourceSSECustomerKeyMD5
```
public final String copySourceSSECustomerKeyMD5()
```
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
    
    Returns:
    
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
  - requestPayer
```
public final RequestPayer requestPayer()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - requestPayerAsString
```
public final String requestPayerAsString()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - expectedBucketOwner
```
public final String expectedBucketOwner()
```
    The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
    
    Returns:
    
    The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
  - expectedSourceBucketOwner
```
public final String expectedSourceBucketOwner()
```
    The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
    
    Returns:
    
    The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
  - bucket
```
@Deprecated
public final String bucket()
```
    Deprecated.
    Use destinationBucket()
    
    The bucket name.
    
    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.
    
    Returns:
    
    The bucket name.
    
    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.
  - destinationBucket
```
public final String destinationBucket()
```
    The bucket name.
    
    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.
    
    Returns:
    
    The bucket name.
    
    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.
  - key
```
@Deprecated
public final String key()
```
    Deprecated.
    Use destinationKey()
    
    Object key for which the multipart upload was initiated.
    
    Returns:
    
    Object key for which the multipart upload was initiated.
  - destinationKey
```
public final String destinationKey()
```
    Object key for which the multipart upload was initiated.
    
    Returns:
    
    Object key for which the multipart upload was initiated.
  - sourceBucket
```
public final String sourceBucket()
```
    The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
    
    Returns:
    
    The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
  - sourceKey
```
public final String sourceKey()
```
    The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
    
    Returns:
    
    The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
  - sourceVersionId
```
public final String sourceVersionId()
```
    Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
    
    Returns:
    
    Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
  - toBuilder
```
public UploadPartCopyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UploadPartCopyRequest.Builder,UploadPartCopyRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static UploadPartCopyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UploadPartCopyRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UploadPartCopyRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

copySource

copySourceIfMatch

copySourceIfModifiedSince

copySourceIfNoneMatch

copySourceIfUnmodifiedSince

copySourceRange

partNumber

uploadId

sseCustomerAlgorithm

sseCustomerKey

sseCustomerKeyMD5

copySourceSSECustomerAlgorithm

copySourceSSECustomerKey

copySourceSSECustomerKeyMD5

requestPayer

requestPayerAsString

expectedBucketOwner

expectedSourceBucketOwner

bucket

destinationBucket

key

destinationKey

sourceBucket

sourceKey

sourceVersionId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields