software.amazon.awssdk.services.s3.model

Class PutBucketAclRequest

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(value="software.amazon.awssdk:codegen")
public final class PutBucketAclRequest
extends S3Request
implements ToCopyableBuilder<PutBucketAclRequest.Builder,PutBucketAclRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutBucketAclRequest.Builder

Method Summary

Modifier and Type	Method and 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()
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, overwrite, and delete any object in the bucket.
String	grantWriteACP() Allows grantee to write the ACL for the applicable bucket.
int	hashCode()
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 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 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 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 String bucket()

The bucket to which to apply the ACL.

Returns:

The bucket to which to apply the ACL.

contentMD5

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

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.

grantFullControl

public 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 String grantRead()

Allows grantee to list the objects in the bucket.

Returns:

Allows grantee to list the objects in the bucket.

grantReadACP

public String grantReadACP()

Allows grantee to read the bucket ACL.

Returns:

Allows grantee to read the bucket ACL.

grantWrite

public String grantWrite()

Allows grantee to create, overwrite, and delete any object in the bucket.

Returns:

Allows grantee to create, overwrite, and delete any object in the bucket.

grantWriteACP

public 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 String expectedBucketOwner()

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo