software.amazon.awssdk.services.s3.model

Class UploadPartRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UploadPartRequest.Builder,UploadPartRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UploadPartRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() Name of the bucket to which the multipart upload was initiated.
static UploadPartRequest.Builder	builder()
Long	contentLength() Size of the body in bytes.
String	contentMD5() The base64-encoded 128-bit MD5 digest of the part data.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	key() Object key for which the multipart upload was initiated.
Integer	partNumber() Part number of part being uploaded.
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 UploadPartRequest.Builder>	serializableBuilderClass()
String	sseCustomerAlgorithm() Specifies the algorithm to use to when encrypting the object (e.g., 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.
UploadPartRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	uploadId() Upload ID identifying the multipart upload whose part is being uploaded.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

bucket

public String bucket()

Name of the bucket to which the multipart upload was initiated.

Returns:

Name of the bucket to which the multipart upload was initiated.

contentLength

public Long contentLength()

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

Returns:

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

contentMD5

public String contentMD5()

The base64-encoded 128-bit MD5 digest of the part data.

Returns:

The base64-encoded 128-bit MD5 digest of the part data.

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 uploaded. This is a positive integer between 1 and 10,000.

Returns:

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

uploadId

public String uploadId()

Upload ID identifying the multipart upload whose part is being uploaded.

Returns:

Upload ID identifying the multipart upload whose part is being uploaded.

sseCustomerAlgorithm

public String sseCustomerAlgorithm()

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

Specifies the algorithm to use to when encrypting the object (e.g., 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 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 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 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 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 UploadPartRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UploadPartRequest.Builder,UploadPartRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static UploadPartRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UploadPartRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.