software.amazon.awssdk.services.s3.model

Class UploadPartCopyRequest

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(value="software.amazon.awssdk:codegen")
public final class UploadPartCopyRequest
extends S3Request
implements ToCopyableBuilder<UploadPartCopyRequest.Builder,UploadPartCopyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UploadPartCopyRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The bucket name.
static UploadPartCopyRequest.Builder	builder()
String	copySource() The name of the source bucket and key name of the source object, separated by a slash (/).
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() Object key for which the multipart upload was initiated.
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	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

bucket

public String bucket()

The bucket name.

Returns:

The bucket name.

copySource

public String copySource()

The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

Returns:

The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

copySourceIfMatch

public 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 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 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 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 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.

key

public String key()

Object key for which the multipart upload was initiated.

Returns:

Object key for which the multipart upload was initiated.

partNumber

public 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 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 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 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 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 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 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 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 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 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

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo