Interface DeleteObjectRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DeleteObjectRequest.Builder,DeleteObjectRequest>, S3Request.Builder, SdkBuilder<DeleteObjectRequest.Builder,DeleteObjectRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DeleteObjectRequest
@Mutable @NotThreadSafe public static interface DeleteObjectRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<DeleteObjectRequest.Builder,DeleteObjectRequest>

  • Method Details

    • bucket

      DeleteObjectRequest.Builder bucket(String bucket)

      The bucket name of the bucket containing the object.

      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 of the bucket containing the object.

      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

      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.

      This functionality is not supported for directory buckets.

      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.

      This functionality is not supported for directory buckets.

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

    • versionId

      DeleteObjectRequest.Builder versionId(String versionId)

      Version ID used to reference a specific version of the object.

      For directory buckets in this API operation, only the null value of the version ID is supported.

      Parameters:
      versionId - Version ID used to reference a specific version of the object.

      For directory buckets in this API operation, only the null value of the version ID is supported.

      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

      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:

    • 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:BypassGovernanceRetention permission.

      This functionality is not supported for directory buckets.

      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:BypassGovernanceRetention permission.

      This functionality is not supported for directory buckets.

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

    • ifMatch

      DeleteObjectRequest.Builder ifMatch(String ifMatch)

      The If-Match header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a 412 Precondition Failed error. If the ETag matches or if the object doesn't exist, the operation will return a 204 Success (No Content) response.

      For more information about conditional requests, see RFC 7232.

      This functionality is only supported for directory buckets.

      Parameters:
      ifMatch - The If-Match header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a 412 Precondition Failed error. If the ETag matches or if the object doesn't exist, the operation will return a 204 Success (No Content) response.

      For more information about conditional requests, see RFC 7232.

      This functionality is only supported for directory buckets.

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

    • ifMatchLastModifiedTime

      DeleteObjectRequest.Builder ifMatchLastModifiedTime(Instant ifMatchLastModifiedTime)

      If present, the object is deleted only if its modification times matches the provided Timestamp. If the Timestamp values do not match, the operation returns a 412 Precondition Failed error. If the Timestamp matches or if the object doesn’t exist, the operation returns a 204 Success (No Content) response.

      This functionality is only supported for directory buckets.

      Parameters:
      ifMatchLastModifiedTime - If present, the object is deleted only if its modification times matches the provided Timestamp. If the Timestamp values do not match, the operation returns a 412 Precondition Failed error. If the Timestamp matches or if the object 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.

    • ifMatchSize

      DeleteObjectRequest.Builder ifMatchSize(Long ifMatchSize)

      If present, the object is deleted only if its size matches the provided size in bytes. If the Size value does not match, the operation returns a 412 Precondition Failed error. If the Size matches or if the object doesn’t exist, the operation returns a 204 Success (No Content) response.

      This functionality is only supported for directory buckets.

      You can use the If-Match, x-amz-if-match-last-modified-time and x-amz-if-match-size conditional headers in conjunction with each-other or individually.

      Parameters:
      ifMatchSize - If present, the object is deleted only if its size matches the provided size in bytes. If the Size value does not match, the operation returns a 412 Precondition Failed error. If the Size matches or if the object doesn’t exist, the operation returns a 204 Success (No Content) response.

      This functionality is only supported for directory buckets.

      You can use the If-Match, x-amz-if-match-last-modified-time and x-amz-if-match-size conditional headers in conjunction with each-other or individually.

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

    • overrideConfiguration

      DeleteObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeleteObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.