@Generated(value="software.amazon.awssdk:codegen") public final class CreateMultipartUploadResponse extends S3Response implements ToCopyableBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateMultipartUploadResponse.Builder |
Modifier and Type | Method and Description |
---|---|
Instant |
abortDate()
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix
in the lifecycle rule matches the object name in the request, the response includes this header.
|
String |
abortRuleId()
This header is returned along with the
x-amz-abort-date header. |
String |
bucket()
The name of the bucket to which the multipart upload was initiated.
|
Boolean |
bucketKeyEnabled()
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management
Service (KMS) keys (SSE-KMS).
|
static CreateMultipartUploadResponse.Builder |
builder() |
ChecksumAlgorithm |
checksumAlgorithm()
The algorithm that was used to create a checksum of the object.
|
String |
checksumAlgorithmAsString()
The algorithm that was used to create a checksum of the object.
|
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.
|
RequestCharged |
requestCharged()
Returns the value of the RequestCharged property for this object.
|
String |
requestChargedAsString()
Returns the value of the RequestCharged property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateMultipartUploadResponse.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256 , aws:kms ). |
String |
serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256 , aws:kms ). |
String |
sseCustomerAlgorithm()
If server-side encryption with a customer-provided encryption key was requested, the response will include this
header confirming the encryption algorithm used.
|
String |
sseCustomerKeyMD5()
If server-side encryption with a customer-provided encryption key was requested, the response will include this
header to provide round-trip message integrity verification of the customer-provided encryption key.
|
String |
ssekmsEncryptionContext()
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption.
|
String |
ssekmsKeyId()
If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that
was used for the object.
|
CreateMultipartUploadResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
uploadId()
ID for the initiated multipart upload.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Instant abortDate()
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
The response also includes the x-amz-abort-rule-id
header that provides the ID of the lifecycle
configuration rule that defines this action.
The response also includes the x-amz-abort-rule-id
header that provides the ID of the
lifecycle configuration rule that defines this action.
public final String abortRuleId()
This header is returned along with the x-amz-abort-date
header. It identifies the applicable
lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
x-amz-abort-date
header. It identifies the applicable
lifecycle configuration rule that defines the action to abort incomplete multipart uploads.public final String bucket()
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
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.
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.
public final String key()
Object key for which the multipart upload was initiated.
public final String uploadId()
ID for the initiated multipart upload.
public final ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
AES256
, aws:kms
).ServerSideEncryption
public final String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
AES256
, aws:kms
).ServerSideEncryption
public final String sseCustomerAlgorithm()
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
public final String sseCustomerKeyMD5()
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
public final String ssekmsKeyId()
If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
public final String ssekmsEncryptionContext()
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
public final Boolean bucketKeyEnabled()
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
public final RequestCharged requestCharged()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final String requestChargedAsString()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final ChecksumAlgorithm checksumAlgorithm()
The algorithm that was used to create a checksum of the object.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
ChecksumAlgorithm
public final String checksumAlgorithmAsString()
The algorithm that was used to create a checksum of the object.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
ChecksumAlgorithm
public CreateMultipartUploadResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>
toBuilder
in class AwsResponse
public static CreateMultipartUploadResponse.Builder builder()
public static Class<? extends CreateMultipartUploadResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2023. All rights reserved.