software.amazon.awssdk.services.s3.model

Class CreateMultipartUploadResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.s3.model.S3Response

software.amazon.awssdk.services.s3.model.CreateMultipartUploadResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateMultipartUploadResponse.Builder

Method Summary

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 AWS KMS (SSE-KMS).
static CreateMultipartUploadResponse.Builder	builder()
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 AWS KMS Encryption Context to use for object encryption.
String	ssekmsKeyId() If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) 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.

Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

abortDate

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

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

Returns:

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

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

abortRuleId

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.

Returns:

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.

bucket

public final 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 AWS 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 using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Returns:

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 AWS 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 using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

key

public final String key()

Object key for which the multipart upload was initiated.

Returns:

Object key for which the multipart upload was initiated.

uploadId

public final String uploadId()

ID for the initiated multipart upload.

Returns:

ID for the initiated multipart upload.

serverSideEncryption

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().

Returns:

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

See Also:

ServerSideEncryption

serverSideEncryptionAsString

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().

Returns:

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

See Also:

ServerSideEncryption

sseCustomerAlgorithm

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.

Returns:

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

sseCustomerKeyMD5

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.

Returns:

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.

ssekmsKeyId

public final String ssekmsKeyId()

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

Returns:

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

ssekmsEncryptionContext

public final String ssekmsEncryptionContext()

If present, specifies the AWS 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.

Returns:

If present, specifies the AWS 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.

bucketKeyEnabled

public final Boolean bucketKeyEnabled()

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

Returns:

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

requestCharged

public final RequestCharged requestCharged()

Returns the value of the RequestCharged property for this object.

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().

Returns:

The value of the RequestCharged property for this object.

See Also:

RequestCharged

requestChargedAsString

public final String requestChargedAsString()

Returns the value of the RequestCharged property for this object.

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().

Returns:

The value of the RequestCharged property for this object.

See Also:

RequestCharged

toBuilder

public CreateMultipartUploadResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateMultipartUploadResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo