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

Class PutPublicAccessBlockRequest

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.PutPublicAccessBlockRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutPublicAccessBlockRequest.Builder,PutPublicAccessBlockRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutPublicAccessBlockRequest extends S3Request implements ToCopyableBuilder<PutPublicAccessBlockRequest.Builder,PutPublicAccessBlockRequest>

  • Method Details

    • bucket

      public final String bucket()

      The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

      Returns:
      The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

    • contentMD5

      public final String contentMD5()

      The MD5 hash of the PutPublicAccessBlock 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 PutPublicAccessBlock 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 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 object 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:

    • checksumAlgorithmAsString

      public final String checksumAlgorithmAsString()

      Indicates the algorithm used to create the checksum for the object 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 object 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:

    • publicAccessBlockConfiguration

      public final PublicAccessBlockConfiguration publicAccessBlockConfiguration()

      The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

      Returns:
      The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

    • 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 PutPublicAccessBlockRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutPublicAccessBlockRequest.Builder,PutPublicAccessBlockRequest>
      Specified by:
      toBuilder in class S3Request

    • builder

      public static PutPublicAccessBlockRequest.Builder builder()

    • serializableBuilderClass

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