Class PutBucketEncryptionRequest
- 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.PutBucketEncryptionRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<PutBucketEncryptionRequest.Builder,PutBucketEncryptionRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutBucketEncryptionRequest extends S3Request implements ToCopyableBuilder<PutBucketEncryptionRequest.Builder,PutBucketEncryptionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePutBucketEncryptionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringbucket()Specifies default encryption for a bucket using server-side encryption with different key options.static PutBucketEncryptionRequest.Builderbuilder()ChecksumAlgorithmchecksumAlgorithm()Indicates the algorithm used to create the checksum for the request when you use the SDK.StringchecksumAlgorithmAsString()Indicates the algorithm used to create the checksum for the request when you use the SDK.StringcontentMD5()The Base64 encoded 128-bitMD5digest of the server-side encryption configuration.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexpectedBucketOwner()The account ID of the expected bucket owner.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PutBucketEncryptionRequest.Builder>serializableBuilderClass()ServerSideEncryptionConfigurationserverSideEncryptionConfiguration()Returns the value of the ServerSideEncryptionConfiguration property for this object.PutBucketEncryptionRequest.BuildertoBuilder()StringtoString()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()
Specifies default encryption for a bucket using server-side encryption with different key options.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the formatbucket-base-name--zone-id--x-s3(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide- Returns:
- Specifies default encryption for a bucket using server-side encryption with different key options.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the formatbucket-base-name--zone-id--x-s3(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
-
contentMD5
public final String contentMD5()
The Base64 encoded 128-bit
MD5digest of the server-side encryption configuration.For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
This functionality is not supported for directory buckets.
- Returns:
- The Base64 encoded 128-bit
MD5digest of the server-side encryption configuration.For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
This functionality is not supported for directory buckets.
-
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-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.For directory buckets, when you use Amazon Web Services SDKs,
CRC32is the default checksum algorithm that's used for performance.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithmwill returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromchecksumAlgorithmAsString().- 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-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.For directory buckets, when you use Amazon Web Services SDKs,
CRC32is the default checksum algorithm that's used for performance. - 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-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.For directory buckets, when you use Amazon Web Services SDKs,
CRC32is the default checksum algorithm that's used for performance.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithmwill returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromchecksumAlgorithmAsString().- 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-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.For directory buckets, when you use Amazon Web Services SDKs,
CRC32is the default checksum algorithm that's used for performance. - See Also:
ChecksumAlgorithm
-
serverSideEncryptionConfiguration
public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()
Returns the value of the ServerSideEncryptionConfiguration property for this object.- Returns:
- The value of the ServerSideEncryptionConfiguration property for this object.
-
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).For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
501 Not Implemented.- 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).For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
501 Not Implemented.
-
toBuilder
public PutBucketEncryptionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PutBucketEncryptionRequest.Builder,PutBucketEncryptionRequest>- Specified by:
toBuilderin classS3Request
-
builder
public static PutBucketEncryptionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutBucketEncryptionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-