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

Class VersioningConfiguration

java.lang.Object
software.amazon.awssdk.services.s3.model.VersioningConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VersioningConfiguration.Builder,VersioningConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class VersioningConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VersioningConfiguration.Builder,VersioningConfiguration>

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference.

See Also:

  • Method Details

    • mfaDelete

      public final MFADelete mfaDelete()

      Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

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

      Returns:
      Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
      See Also:

    • mfaDeleteAsString

      public final String mfaDeleteAsString()

      Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

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

      Returns:
      Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
      See Also:

    • status

      public final BucketVersioningStatus status()

      The versioning state of the bucket.

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

      Returns:
      The versioning state of the bucket.
      See Also:

    • statusAsString

      public final String statusAsString()

      The versioning state of the bucket.

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

      Returns:
      The versioning state of the bucket.
      See Also:

    • toBuilder

      public VersioningConfiguration.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<VersioningConfiguration.Builder,VersioningConfiguration>
      Returns:
      a builder for type T

    • builder

      public static VersioningConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VersioningConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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