Class UploadPartRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UploadPartRequest.Builder,
UploadPartRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
bucket()
The name of the bucket to which the multipart upload was initiated.static UploadPartRequest.Builder
builder()
final ChecksumAlgorithm
Indicates the algorithm used to create the checksum for the object when you use the SDK.final String
Indicates the algorithm used to create the checksum for the object when you use the SDK.final String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.final String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.final String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.final String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.final Long
Size of the body in bytes.final String
The base64-encoded 128-bit MD5 digest of the part data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The account ID of the expected bucket owner.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
key()
Object key for which the multipart upload was initiated.final Integer
Part number of part being uploaded.final RequestPayer
Returns the value of the RequestPayer property for this object.final String
Returns the value of the RequestPayer property for this object.final SdkPartType
Indicates whether the request is a last part or not.final String
Indicates whether the request is a last part or not.static Class
<? extends UploadPartRequest.Builder> final String
Specifies the algorithm to use when encrypting the object (for example, AES256).final String
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.final String
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bucket
The name of the bucket to which the multipart upload was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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 name of the bucket to which the multipart upload was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.
-
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
The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.
This functionality is not supported for directory buckets.
- Returns:
- The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the
command from the CLI. This parameter is required if object lock parameters are specified.
This functionality is not supported for directory buckets.
-
checksumAlgorithm
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will
not provide any additional functionality if you don't use the SDK. When you send this header, there must
be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request. - See Also:
-
checksumAlgorithmAsString
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will
not provide any additional functionality if you don't use the SDK. When you send this header, there must
be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request. - See Also:
-
checksumCRC32
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Returns:
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
-
checksumCRC32C
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Returns:
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
-
checksumSHA1
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Returns:
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
-
checksumSHA256
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Returns:
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
-
key
Object key for which the multipart upload was initiated.
- Returns:
- Object key for which the multipart upload was initiated.
-
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
Upload ID identifying the multipart upload whose part is being uploaded.
- Returns:
- Upload ID identifying the multipart upload whose part is being uploaded.
-
sseCustomerAlgorithm
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
- Returns:
- Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
-
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.This functionality is not supported for directory buckets.
- 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.This functionality is not supported for directory buckets.
-
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.
This functionality is not supported for directory buckets.
- 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.
This functionality is not supported for directory buckets.
-
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 returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
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 returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
expectedBucketOwner
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).- Returns:
- The account ID of the expected bucket owner. If the account ID that you provide does not match the actual
owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).
-
sdkPartType
Indicates whether the request is a last part or not. This field will not be included in the request payload.If the service returns an enum value that is not available in the current SDK version,
sdkPartType
will returnSdkPartType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsdkPartTypeAsString()
.- Returns:
- Indicates whether the request is a last part or not. This field will not be included in the request payload.
- See Also:
-
sdkPartTypeAsString
Indicates whether the request is a last part or not. This field will not be included in the request payload.If the service returns an enum value that is not available in the current SDK version,
sdkPartType
will returnSdkPartType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsdkPartTypeAsString()
.- Returns:
- Indicates whether the request is a last part or not. This field will not be included in the request payload.
- See Also:
-
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 interfaceToCopyableBuilder<UploadPartRequest.Builder,
UploadPartRequest> - Specified by:
toBuilder
in classS3Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-