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

Class PutBucketAclRequest

java.lang.Object

com.ibm.cos.v2.core.SdkRequest

com.ibm.cos.v2.awscore.AwsRequest

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

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutBucketAclRequest.Builder,PutBucketAclRequest>

@Generated(value="com.ibm.cos.v2: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()
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) Indicates whether some other object is "equal to" this one by SDK fields.
String	expectedBucketOwner() The account ID of the expected bucket owner.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutBucketAclRequest.Builder,PutBucketAclRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.