Class DeleteRetentionPolicy


  • public final class DeleteRetentionPolicy
    extends Object
    The service properties for soft delete.
    • Constructor Detail

      • DeleteRetentionPolicy

        public DeleteRetentionPolicy()
    • Method Detail

      • enabled

        public Boolean enabled()
        Get the enabled property: Indicates whether DeleteRetentionPolicy is enabled.
        Returns:
        the enabled value.
      • withEnabled

        public DeleteRetentionPolicy withEnabled​(Boolean enabled)
        Set the enabled property: Indicates whether DeleteRetentionPolicy is enabled.
        Parameters:
        enabled - the enabled value to set.
        Returns:
        the DeleteRetentionPolicy object itself.
      • days

        public Integer days()
        Get the days property: Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.
        Returns:
        the days value.
      • withDays

        public DeleteRetentionPolicy withDays​(Integer days)
        Set the days property: Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.
        Parameters:
        days - the days value to set.
        Returns:
        the DeleteRetentionPolicy object itself.
      • allowPermanentDelete

        public Boolean allowPermanentDelete()
        Get the allowPermanentDelete property: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share.
        Returns:
        the allowPermanentDelete value.
      • withAllowPermanentDelete

        public DeleteRetentionPolicy withAllowPermanentDelete​(Boolean allowPermanentDelete)
        Set the allowPermanentDelete property: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share.
        Parameters:
        allowPermanentDelete - the allowPermanentDelete value to set.
        Returns:
        the DeleteRetentionPolicy object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.