DeleteObjectsRequest.Builder (IBM COS Java SDK

All Superinterfaces:

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

Enclosing class:

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DeleteObjectsRequest.Builder`	`bucket(String bucket)` The bucket name containing the objects to delete.
`DeleteObjectsRequest.Builder`	`bypassGovernanceRetention(Boolean bypassGovernanceRetention)` Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place.
`DeleteObjectsRequest.Builder`	`checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)` Indicates the algorithm used to create the checksum for the object when you use the SDK.
`DeleteObjectsRequest.Builder`	`checksumAlgorithm(String checksumAlgorithm)` Indicates the algorithm used to create the checksum for the object when you use the SDK.
`default DeleteObjectsRequest.Builder`	`delete(Consumer<Delete.Builder> delete)` Container for the request.
`DeleteObjectsRequest.Builder`	`delete(Delete delete)` Container for the request.
`DeleteObjectsRequest.Builder`	`expectedBucketOwner(String expectedBucketOwner)` The account ID of the expected bucket owner.
`DeleteObjectsRequest.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.
`DeleteObjectsRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)` Add an optional request override configuration.
`DeleteObjectsRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)` Add an optional request override configuration.
`DeleteObjectsRequest.Builder`	`requestPayer(RequestPayer requestPayer)` Sets the value of the RequestPayer property for this object.
`DeleteObjectsRequest.Builder`	`requestPayer(String requestPayer)` Sets the value of the RequestPayer property for this object.

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Request.Builder
build

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder
copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - bucket
```
DeleteObjectsRequest.Builder bucket(String bucket)
```
    The bucket name containing the objects to delete.
    
    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 containing the objects to delete.
    
    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.
  - delete
```
DeleteObjectsRequest.Builder delete(Delete delete)
```
    Container for the request.
    
    Parameters:
    
    delete - Container for the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - delete
```
default DeleteObjectsRequest.Builder delete(Consumer<Delete.Builder> delete)
```
    Container for the request.
    This is a convenience method that creates an instance of the Delete.Builder avoiding the need to create one manually via Delete.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to delete(Delete).
    
    Parameters:
    
    delete - a consumer that will call methods on Delete.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    delete(Delete)
  - mfa
```
DeleteObjectsRequest.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.
    
    When performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.
    
    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.
    
    When performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - requestPayer
```
DeleteObjectsRequest.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
```
DeleteObjectsRequest.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
```
DeleteObjectsRequest.Builder bypassGovernanceRetention(Boolean bypassGovernanceRetention)
```
    Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    bypassGovernanceRetention - Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. 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
```
DeleteObjectsRequest.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.
  - checksumAlgorithm
```
DeleteObjectsRequest.Builder checksumAlgorithm(String checksumAlgorithm)
```
    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    - CRC32
    - CRC32C
    - CRC64NVME
    - SHA1
    - SHA256
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
    Parameters:
    checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    
    CRC32
    
    CRC32C
    
    CRC64NVME
    
    SHA1
    
    SHA256
    
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChecksumAlgorithm, ChecksumAlgorithm
  - checksumAlgorithm
```
DeleteObjectsRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
```
    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    - CRC32
    - CRC32C
    - CRC64NVME
    - SHA1
    - SHA256
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
    Parameters:
    checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    
    CRC32
    
    CRC32C
    
    CRC64NVME
    
    SHA1
    
    SHA256
    
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChecksumAlgorithm, ChecksumAlgorithm
  - overrideConfiguration
```
DeleteObjectsRequest.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
```
DeleteObjectsRequest.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.

Interface DeleteObjectsRequest.Builder

Method Summary

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Request.Builder

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

Method Detail

bucket

delete

delete

mfa

requestPayer

requestPayer

bypassGovernanceRetention

expectedBucketOwner

checksumAlgorithm

checksumAlgorithm

overrideConfiguration

overrideConfiguration