Package software.amazon.awssdk.services.s3.model

Interface AbortMultipartUploadRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AbortMultipartUploadRequest.Builder,AbortMultipartUploadRequest>, S3Request.Builder, SdkBuilder<AbortMultipartUploadRequest.Builder,AbortMultipartUploadRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AbortMultipartUploadRequest

@Mutable
@NotThreadSafe
public static interface AbortMultipartUploadRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<AbortMultipartUploadRequest.Builder,AbortMultipartUploadRequest>

Method Summary

Modifier and Type	Method	Description
AbortMultipartUploadRequest.Builder	bucket(String bucket)	The bucket name to which the upload was taking place.
AbortMultipartUploadRequest.Builder	expectedBucketOwner(String expectedBucketOwner)	The account ID of the expected bucket owner.
AbortMultipartUploadRequest.Builder	ifMatchInitiatedTime(Instant ifMatchInitiatedTime)	If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp.
AbortMultipartUploadRequest.Builder	key(String key)	Key of the object for which the multipart upload was initiated.
AbortMultipartUploadRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AbortMultipartUploadRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AbortMultipartUploadRequest.Builder	requestPayer(String requestPayer)	Sets the value of the RequestPayer property for this object.
AbortMultipartUploadRequest.Builder	requestPayer(RequestPayer requestPayer)	Sets the value of the RequestPayer property for this object.
AbortMultipartUploadRequest.Builder	uploadId(String uploadId)	Upload ID that identifies the multipart upload.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

bucket

AbortMultipartUploadRequest.Builder bucket(String bucket)

The bucket name to which the upload was taking place.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Parameters:

bucket - The bucket name to which the upload was taking place.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

key

AbortMultipartUploadRequest.Builder key(String key)

Key of the object for which the multipart upload was initiated.

Parameters:

key - Key of the object for which the multipart upload was initiated.

Returns:

Returns a reference to this object so that method calls can be chained together.

uploadId

AbortMultipartUploadRequest.Builder uploadId(String uploadId)

Upload ID that identifies the multipart upload.

Parameters:

uploadId - Upload ID that identifies the multipart upload.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestPayer

AbortMultipartUploadRequest.Builder requestPayer(String requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

requestPayer

AbortMultipartUploadRequest.Builder requestPayer(RequestPayer requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

expectedBucketOwner

AbortMultipartUploadRequest.Builder expectedBucketOwner(String 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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

ifMatchInitiatedTime

AbortMultipartUploadRequest.Builder ifMatchInitiatedTime(Instant ifMatchInitiatedTime)

If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a 412 Precondition Failed error. If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

Parameters:

ifMatchInitiatedTime - If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a 412 Precondition Failed error. If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

AbortMultipartUploadRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

AbortMultipartUploadRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder