Copyright Microsoft Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
/**
 * Copyright Microsoft Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.microsoft.azure.storage;

Represents the policy governing the retention of deleted blobs.
/**
 * Represents the policy governing the retention of deleted blobs.
 */
public class DeleteRetentionPolicy {
    
Indicates whether a deleted blob or snapshot is retained or immediately removed by a delete operation.
/**
     * Indicates whether a deleted blob or snapshot is retained or immediately removed by a delete operation.
     */
    private boolean enabled = false;

    
Required only if Enabled is true. Indicates the number of days that deleted blobs are retained.
All data older than this value will be permanently deleted.
The minimum value you can specify is 1; the largest value is 365.
/**
     * Required only if Enabled is true. Indicates the number of days that deleted blobs are retained.
     * All data older than this value will be permanently deleted.
     * The minimum value you can specify is 1; the largest value is 365.
     */
    private Integer retentionIntervalInDays;

    
Return a boolean indicating whether the DeleteRetentionPolicy is enabled.
Returns:
A boolean indicating whether a deleted blob or snapshot is retained or immediately removed by a delete operation./**
     * Return a boolean indicating whether the DeleteRetentionPolicy is enabled.
     *
     * @return A <code>boolean</code> indicating whether a deleted blob or snapshot is retained or immediately removed by a delete operation.
     */
    public boolean getEnabled() {
        return this.enabled;
    }

    
Get the retention interval(in days) of the DeleteRetentionPolicy.
Returns:
An Integer which contains the retention interval./**
     * Get the retention interval(in days) of the DeleteRetentionPolicy.
     *
     * @return An <code>Integer</code> which contains the retention interval.
     */
    public Integer getRetentionIntervalInDays() {
        return this.retentionIntervalInDays;
    }

    
Set a boolean indicating whether the DeleteRetentionPolicy is enabled.
Params:
enabled – indicates whether the DeleteRetentionPolicy is enabled./**
     * Set a boolean indicating whether the DeleteRetentionPolicy is enabled.
     * @param enabled indicates whether the DeleteRetentionPolicy is enabled.
     */
    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    
Set the retention interval in days for the delete retention policy.
Params:
retentionIntervalInDays – represents the number of days that a deleted blob is retained./**
     * Set the retention interval in days for the delete retention policy.
     * @param retentionIntervalInDays represents the number of days that a deleted blob is retained.
     */
    public void setRetentionIntervalInDays(final Integer retentionIntervalInDays) {
        this.retentionIntervalInDays = retentionIntervalInDays;
    }
}