java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.PutBucketAclRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutBucketAclRequest.Builder,PutBucketAclRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutBucketAclRequest
extends S3Request
implements ToCopyableBuilder<PutBucketAclRequest.Builder,PutBucketAclRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PutBucketAclRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccessControlPolicy`	`accessControlPolicy()`	Contains the elements that set the ACL permissions for an object per grantee.
`BucketCannedACL`	`acl()`	The canned ACL to apply to the bucket.
`String`	`aclAsString()`	The canned ACL to apply to the bucket.
`String`	`bucket()`	The bucket to which to apply the ACL.
`static PutBucketAclRequest.Builder`	`builder()`
`ChecksumAlgorithm`	`checksumAlgorithm()`	Indicates the algorithm used to create the checksum for the request when you use the SDK.
`String`	`checksumAlgorithmAsString()`	Indicates the algorithm used to create the checksum for the request when you use the SDK.
`String`	`contentMD5()`	The Base64 encoded 128-bit `MD5` digest of the data.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`expectedBucketOwner()`	The account ID of the expected bucket owner.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`grantFullControl()`	Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
`String`	`grantRead()`	Allows grantee to list the objects in the bucket.
`String`	`grantReadACP()`	Allows grantee to read the bucket ACL.
`String`	`grantWrite()`	Allows grantee to create new objects in the bucket.
`String`	`grantWriteACP()`	Allows grantee to write the ACL for the applicable bucket.
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutBucketAclRequest.Builder>`	`serializableBuilderClass()`
`PutBucketAclRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - acl
```
public final BucketCannedACL acl()
```
    The canned ACL to apply to the bucket.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return BucketCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the bucket.
    
    See Also:
    
    BucketCannedACL
  - aclAsString
```
public final String aclAsString()
```
    The canned ACL to apply to the bucket.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return BucketCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the bucket.
    
    See Also:
    
    BucketCannedACL
  - accessControlPolicy
```
public final AccessControlPolicy accessControlPolicy()
```
    Contains the elements that set the ACL permissions for an object per grantee.
    
    Returns:
    
    Contains the elements that set the ACL permissions for an object per grantee.
  - bucket
```
public final String bucket()
```
    The bucket to which to apply the ACL.
    
    Returns:
    
    The bucket to which to apply the ACL.
  - contentMD5
```
public final 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.
    
    Returns:
    
    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.
  - checksumAlgorithm
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ChecksumAlgorithm
  - checksumAlgorithmAsString
```
public final String checksumAlgorithmAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ChecksumAlgorithm
  - grantFullControl
```
public final String grantFullControl()
```
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
    
    Returns:
    
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
  - grantRead
```
public final String grantRead()
```
    Allows grantee to list the objects in the bucket.
    
    Returns:
    
    Allows grantee to list the objects in the bucket.
  - grantReadACP
```
public final String grantReadACP()
```
    Allows grantee to read the bucket ACL.
    
    Returns:
    
    Allows grantee to read the bucket ACL.
  - grantWrite
```
public final 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.
    
    Returns:
    
    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.
  - grantWriteACP
```
public final String grantWriteACP()
```
    Allows grantee to write the ACL for the applicable bucket.
    
    Returns:
    
    Allows grantee to write the ACL for the applicable bucket.
  - expectedBucketOwner
```
public final 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).
    
    Returns:
    
    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).
  - toBuilder
```
public PutBucketAclRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutBucketAclRequest.Builder,PutBucketAclRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static PutBucketAclRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutBucketAclRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class PutBucketAclRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

acl

aclAsString

accessControlPolicy

bucket

contentMD5

checksumAlgorithm

checksumAlgorithmAsString

grantFullControl

grantRead

grantReadACP

grantWrite

grantWriteACP

expectedBucketOwner

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField