software.amazon.awssdk.services.s3.model

Interface DeleteObjectRequest.Builder

All Superinterfaces:

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

Enclosing class:

DeleteObjectRequest

public static interface DeleteObjectRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<DeleteObjectRequest.Builder,DeleteObjectRequest>

Method Summary

Modifier and Type	Method and Description
DeleteObjectRequest.Builder	bucket(String bucket) The bucket name of the bucket containing the object.
DeleteObjectRequest.Builder	bypassGovernanceRetention(Boolean bypassGovernanceRetention) Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
DeleteObjectRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
DeleteObjectRequest.Builder	key(String key) Key name of the object to delete.
DeleteObjectRequest.Builder	mfa(String mfa) The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
DeleteObjectRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DeleteObjectRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DeleteObjectRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
DeleteObjectRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
DeleteObjectRequest.Builder	versionId(String versionId) VersionId used to reference a specific version of the object.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

bucket

DeleteObjectRequest.Builder bucket(String bucket)

The bucket name of the bucket containing the object.

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 using 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 S3 on Outposts in the Amazon S3 User Guide.

Parameters:

bucket - The bucket name of the bucket containing the object.

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 using 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 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

DeleteObjectRequest.Builder key(String key)

Key name of the object to delete.

Parameters:

key - Key name of the object to delete.

Returns:

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

mfa

DeleteObjectRequest.Builder mfa(String mfa)

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Parameters:

mfa - The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Returns:

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

versionId

DeleteObjectRequest.Builder versionId(String versionId)

VersionId used to reference a specific version of the object.

Parameters:

versionId - VersionId used to reference a specific version of the object.

Returns:

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

requestPayer

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

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

bypassGovernanceRetention

DeleteObjectRequest.Builder bypassGovernanceRetention(Boolean bypassGovernanceRetention)

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.

Parameters:

bypassGovernanceRetention - Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.

Returns:

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

expectedBucketOwner

DeleteObjectRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameters:

expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

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

overrideConfiguration

DeleteObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder