public static interface UploadPartRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<UploadPartRequest.Builder,UploadPartRequest>
Modifier and Type | Method and Description |
---|---|
UploadPartRequest.Builder |
bucket(String bucket)
The name of the bucket to which the multipart upload was initiated.
|
UploadPartRequest.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
UploadPartRequest.Builder |
checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
UploadPartRequest.Builder |
checksumCRC32(String 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.
|
UploadPartRequest.Builder |
checksumCRC32C(String 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.
|
UploadPartRequest.Builder |
checksumSHA1(String 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.
|
UploadPartRequest.Builder |
checksumSHA256(String 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.
|
UploadPartRequest.Builder |
contentLength(Long contentLength)
Size of the body in bytes.
|
UploadPartRequest.Builder |
contentMD5(String contentMD5)
The base64-encoded 128-bit MD5 digest of the part data.
|
UploadPartRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
UploadPartRequest.Builder |
key(String key)
Object key for which the multipart upload was initiated.
|
UploadPartRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UploadPartRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
UploadPartRequest.Builder |
partNumber(Integer partNumber)
Part number of part being uploaded.
|
UploadPartRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
UploadPartRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
UploadPartRequest.Builder |
sdkPartType(SdkPartType sdkPartType)
Indicates whether the request is a last part or not.
|
UploadPartRequest.Builder |
sdkPartType(String sdkPartType)
Indicates whether the request is a last part or not.
|
UploadPartRequest.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
UploadPartRequest.Builder |
sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
UploadPartRequest.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
UploadPartRequest.Builder |
uploadId(String uploadId)
Upload ID identifying the multipart upload whose part is being uploaded.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
UploadPartRequest.Builder bucket(String bucket)
The name of the bucket to which the multipart upload was initiated.
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 using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
bucket
- The name of the bucket to which the multipart upload was initiated.
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 using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
UploadPartRequest.Builder contentLength(Long contentLength)
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
contentLength
- Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
automatically.UploadPartRequest.Builder contentMD5(String 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.
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.UploadPartRequest.Builder checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 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.
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when using the SDK. This header
will not provide any additional functionality if not using the SDK. When sending this header, there
must be a corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code 400 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.
ChecksumAlgorithm
,
ChecksumAlgorithm
UploadPartRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 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.
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when using the SDK. This header
will not provide any additional functionality if not using the SDK. When sending this header, there
must be a corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code 400 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.
ChecksumAlgorithm
,
ChecksumAlgorithm
UploadPartRequest.Builder checksumCRC32(String 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.
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.UploadPartRequest.Builder checksumCRC32C(String 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.
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.UploadPartRequest.Builder checksumSHA1(String 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.
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.UploadPartRequest.Builder checksumSHA256(String 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.
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.UploadPartRequest.Builder key(String key)
Object key for which the multipart upload was initiated.
key
- Object key for which the multipart upload was initiated.UploadPartRequest.Builder partNumber(Integer partNumber)
Part number of part being uploaded. This is a positive integer between 1 and 10,000.
partNumber
- Part number of part being uploaded. This is a positive integer between 1 and 10,000.UploadPartRequest.Builder uploadId(String uploadId)
Upload ID identifying the multipart upload whose part is being uploaded.
uploadId
- Upload ID identifying the multipart upload whose part is being uploaded.UploadPartRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
sseCustomerAlgorithm
- Specifies the algorithm to use to when encrypting the object (for example, AES256).UploadPartRequest.Builder sseCustomerKey(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.
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.UploadPartRequest.Builder sseCustomerKeyMD5(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.
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.UploadPartRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
UploadPartRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
UploadPartRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a different account, the
request fails with the HTTP status code 403 Forbidden
(access denied).UploadPartRequest.Builder sdkPartType(String sdkPartType)
sdkPartType
- Indicates whether the request is a last part or not. This field will not be included in the request
payload.SdkPartType
,
SdkPartType
UploadPartRequest.Builder sdkPartType(SdkPartType sdkPartType)
sdkPartType
- Indicates whether the request is a last part or not. This field will not be included in the request
payload.SdkPartType
,
SdkPartType
UploadPartRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
UploadPartRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.