Class PutBucketLifecycleConfigurationRequest

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

  • Method Details

    • bucket

      public final String bucket()

      The name of the bucket for which to set the configuration.

      Returns:
      The name of the bucket for which to set the configuration.

    • 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:

    • 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:

    • lifecycleConfiguration

      public final BucketLifecycleConfiguration lifecycleConfiguration()

      Container for lifecycle rules. You can add as many as 1,000 rules.

      Returns:
      Container for lifecycle rules. You can add as many as 1,000 rules.

    • 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).

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

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

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

    • transitionDefaultMinimumObjectSize

      public final TransitionDefaultMinimumObjectSize transitionDefaultMinimumObjectSize()

      Indicates which default minimum object size behavior is applied to the lifecycle configuration.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

      • all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

      • varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

      To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

      If the service returns an enum value that is not available in the current SDK version, transitionDefaultMinimumObjectSize will return TransitionDefaultMinimumObjectSize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transitionDefaultMinimumObjectSizeAsString().

      Returns:
      Indicates which default minimum object size behavior is applied to the lifecycle configuration.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

      • all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

      • varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

      To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

      See Also:

    • transitionDefaultMinimumObjectSizeAsString

      public final String transitionDefaultMinimumObjectSizeAsString()

      Indicates which default minimum object size behavior is applied to the lifecycle configuration.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

      • all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

      • varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

      To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

      If the service returns an enum value that is not available in the current SDK version, transitionDefaultMinimumObjectSize will return TransitionDefaultMinimumObjectSize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transitionDefaultMinimumObjectSizeAsString().

      Returns:
      Indicates which default minimum object size behavior is applied to the lifecycle configuration.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

      • all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

      • varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

      To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

      See Also:

    • toBuilder

      public PutBucketLifecycleConfigurationRequest.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<PutBucketLifecycleConfigurationRequest.Builder,PutBucketLifecycleConfigurationRequest>
      Specified by:
      toBuilder in class S3Request
      Returns:
      a builder for type T

    • builder

      public static PutBucketLifecycleConfigurationRequest.Builder builder()

    • serializableBuilderClass

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