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

Interface PutBucketAclRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutBucketAclRequest

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

Method Summary

Modifier and Type	Method and Description
PutBucketAclRequest.Builder	accessControlPolicy(AccessControlPolicy accessControlPolicy) Contains the elements that set the ACL permissions for an object per grantee.
default PutBucketAclRequest.Builder	accessControlPolicy(Consumer<AccessControlPolicy.Builder> accessControlPolicy) Contains the elements that set the ACL permissions for an object per grantee.
PutBucketAclRequest.Builder	acl(BucketCannedACL acl) The canned ACL to apply to the bucket.
PutBucketAclRequest.Builder	acl(String acl) The canned ACL to apply to the bucket.
PutBucketAclRequest.Builder	bucket(String bucket) The bucket to which to apply the ACL.
PutBucketAclRequest.Builder	checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm used to create the checksum for the request when you use the SDK.
PutBucketAclRequest.Builder	checksumAlgorithm(String checksumAlgorithm) Indicates the algorithm used to create the checksum for the request when you use the SDK.
PutBucketAclRequest.Builder	contentMD5(String contentMD5) The Base64 encoded 128-bit MD5 digest of the data.
PutBucketAclRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
PutBucketAclRequest.Builder	grantFullControl(String grantFullControl) Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
PutBucketAclRequest.Builder	grantRead(String grantRead) Allows grantee to list the objects in the bucket.
PutBucketAclRequest.Builder	grantReadACP(String grantReadACP) Allows grantee to read the bucket ACL.
PutBucketAclRequest.Builder	grantWrite(String grantWrite) Allows grantee to create new objects in the bucket.
PutBucketAclRequest.Builder	grantWriteACP(String grantWriteACP) Allows grantee to write the ACL for the applicable bucket.
PutBucketAclRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutBucketAclRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

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

acl

PutBucketAclRequest.Builder acl(String acl)

The canned ACL to apply to the bucket.

Parameters:

acl - The canned ACL to apply to the bucket.

Returns:

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

See Also:

BucketCannedACL, BucketCannedACL

acl

PutBucketAclRequest.Builder acl(BucketCannedACL acl)

The canned ACL to apply to the bucket.

Parameters:

acl - The canned ACL to apply to the bucket.

Returns:

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

See Also:

BucketCannedACL, BucketCannedACL

accessControlPolicy

PutBucketAclRequest.Builder accessControlPolicy(AccessControlPolicy accessControlPolicy)

Contains the elements that set the ACL permissions for an object per grantee.

Parameters:

accessControlPolicy - Contains the elements that set the ACL permissions for an object per grantee.

Returns:

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

accessControlPolicy

default PutBucketAclRequest.Builder accessControlPolicy(Consumer<AccessControlPolicy.Builder> accessControlPolicy)

Contains the elements that set the ACL permissions for an object per grantee.

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

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

Parameters:

accessControlPolicy - a consumer that will call methods on AccessControlPolicy.Builder

Returns:

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

See Also:

accessControlPolicy(AccessControlPolicy)

bucket

PutBucketAclRequest.Builder bucket(String bucket)

The bucket to which to apply the ACL.

Parameters:

bucket - The bucket to which to apply the ACL.

Returns:

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

contentMD5

PutBucketAclRequest.Builder contentMD5(String contentMD5)

The Base64 encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to 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. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to 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

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

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

grantFullControl

PutBucketAclRequest.Builder grantFullControl(String grantFullControl)

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

Parameters:

grantFullControl - Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

Returns:

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

grantRead

PutBucketAclRequest.Builder grantRead(String grantRead)

Allows grantee to list the objects in the bucket.

Parameters:

grantRead - Allows grantee to list the objects in the bucket.

Returns:

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

grantReadACP

PutBucketAclRequest.Builder grantReadACP(String grantReadACP)

Allows grantee to read the bucket ACL.

Parameters:

grantReadACP - Allows grantee to read the bucket ACL.

Returns:

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

grantWrite

PutBucketAclRequest.Builder grantWrite(String grantWrite)

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

Parameters:

grantWrite - Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

Returns:

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

grantWriteACP

PutBucketAclRequest.Builder grantWriteACP(String grantWriteACP)

Allows grantee to write the ACL for the applicable bucket.

Parameters:

grantWriteACP - Allows grantee to write the ACL for the applicable bucket.

Returns:

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

expectedBucketOwner

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

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

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