Package software.amazon.awssdk.services.s3.model

Class PutBucketPolicyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutBucketPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The name of the bucket.
static PutBucketPolicyRequest.Builder	builder()
ChecksumAlgorithm	checksumAlgorithm()	Indicates the algorithm used to create the checksum for the object when using the SDK.
String	checksumAlgorithmAsString()	Indicates the algorithm used to create the checksum for the object when using the SDK.
Boolean	confirmRemoveSelfBucketAccess()	Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
String	contentMD5()	The MD5 hash of the request body.
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)
int	hashCode()
String	policy()	The bucket policy as a JSON document.
List<SdkField<?>>	sdkFields()
static Class<? extends PutBucketPolicyRequest.Builder>	serializableBuilderClass()
PutBucketPolicyRequest.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

bucket

public final String bucket()

The name of the bucket.

Returns:

The name of the bucket.

contentMD5

public final String contentMD5()

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Returns:

The MD5 hash of the request body.

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 object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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 object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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 object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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 object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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

confirmRemoveSelfBucketAccess

public final Boolean confirmRemoveSelfBucketAccess()

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

Returns:

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

policy

public final String policy()

The bucket policy as a JSON document.

Returns:

The bucket policy as a JSON document.

expectedBucketOwner

public final String expectedBucketOwner()

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

toBuilder

public PutBucketPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

Specified by:

toBuilder in class S3Request

builder

public static PutBucketPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutBucketPolicyRequest.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