com.ibm.cos.v2.services.s3.model

Interface PutPublicAccessBlockRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutPublicAccessBlockRequest

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

Method Summary

Modifier and Type	Method and Description
PutPublicAccessBlockRequest.Builder	bucket(String bucket) The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.
PutPublicAccessBlockRequest.Builder	checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.
PutPublicAccessBlockRequest.Builder	checksumAlgorithm(String checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.
PutPublicAccessBlockRequest.Builder	contentMD5(String contentMD5) The MD5 hash of the PutPublicAccessBlock request body.
PutPublicAccessBlockRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
PutPublicAccessBlockRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutPublicAccessBlockRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default PutPublicAccessBlockRequest.Builder	publicAccessBlockConfiguration(Consumer<PublicAccessBlockConfiguration.Builder> publicAccessBlockConfiguration) The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
PutPublicAccessBlockRequest.Builder	publicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration) The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.

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

PutPublicAccessBlockRequest.Builder bucket(String bucket)

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

Parameters:

bucket - The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

Returns:

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

contentMD5

PutPublicAccessBlockRequest.Builder contentMD5(String contentMD5)

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Parameters:

contentMD5 - The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Returns:

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

checksumAlgorithm

PutPublicAccessBlockRequest.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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

PutPublicAccessBlockRequest.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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

publicAccessBlockConfiguration

PutPublicAccessBlockRequest.Builder publicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration)

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

Parameters:

publicAccessBlockConfiguration - The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

Returns:

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

publicAccessBlockConfiguration

default PutPublicAccessBlockRequest.Builder publicAccessBlockConfiguration(Consumer<PublicAccessBlockConfiguration.Builder> publicAccessBlockConfiguration)

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

This is a convenience method that creates an instance of the PublicAccessBlockConfiguration.Builder avoiding the need to create one manually via PublicAccessBlockConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to publicAccessBlockConfiguration(PublicAccessBlockConfiguration).

Parameters:

publicAccessBlockConfiguration - a consumer that will call methods on PublicAccessBlockConfiguration.Builder

Returns:

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

See Also:

publicAccessBlockConfiguration(PublicAccessBlockConfiguration)

expectedBucketOwner

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

overrideConfiguration

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

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