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

Interface PutBucketWebsiteRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutBucketWebsiteRequest

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

Method Summary

Modifier and Type	Method and Description
PutBucketWebsiteRequest.Builder	bucket(String bucket) The bucket name.
PutBucketWebsiteRequest.Builder	checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm used to create the checksum for the request when you use the SDK.
PutBucketWebsiteRequest.Builder	checksumAlgorithm(String checksumAlgorithm) Indicates the algorithm used to create the checksum for the request when you use the SDK.
PutBucketWebsiteRequest.Builder	contentMD5(String contentMD5) The Base64 encoded 128-bit MD5 digest of the data.
PutBucketWebsiteRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
PutBucketWebsiteRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutBucketWebsiteRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default PutBucketWebsiteRequest.Builder	websiteConfiguration(Consumer<WebsiteConfiguration.Builder> websiteConfiguration) Container for the request.
PutBucketWebsiteRequest.Builder	websiteConfiguration(WebsiteConfiguration websiteConfiguration) Container for the request.

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

PutBucketWebsiteRequest.Builder bucket(String bucket)

The bucket name.

Parameters:

bucket - The bucket name.

Returns:

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

contentMD5

PutBucketWebsiteRequest.Builder contentMD5(String contentMD5)

The Base64 encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

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 Base64 encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

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

PutBucketWebsiteRequest.Builder checksumAlgorithm(String checksumAlgorithm)

Indicates the algorithm used to create the checksum for the request 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 request 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

PutBucketWebsiteRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

Indicates the algorithm used to create the checksum for the request 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 request 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

websiteConfiguration

PutBucketWebsiteRequest.Builder websiteConfiguration(WebsiteConfiguration websiteConfiguration)

Container for the request.

Parameters:

websiteConfiguration - Container for the request.

Returns:

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

websiteConfiguration

default PutBucketWebsiteRequest.Builder websiteConfiguration(Consumer<WebsiteConfiguration.Builder> websiteConfiguration)

Container for the request.

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

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

Parameters:

websiteConfiguration - a consumer that will call methods on WebsiteConfiguration.Builder

Returns:

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

See Also:

websiteConfiguration(WebsiteConfiguration)

expectedBucketOwner

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

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

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