Package com.azure.storage.file.share.models

Class ShareRetentionPolicy

java.lang.Object

com.azure.storage.file.share.models.ShareRetentionPolicy

public final class ShareRetentionPolicy
extends Object

The retention policy.

Constructor Summary

Constructors

Constructor	Description
ShareRetentionPolicy()

Method Summary

Modifier and Type	Method	Description
Integer	getDays()	Get the days property: Indicates the number of days that metrics data should be retained.
boolean	isEnabled()	Get the enabled property: Indicates whether a retention policy is enabled for the File service.
ShareRetentionPolicy	setDays(Integer days)	Set the days property: Indicates the number of days that metrics data should be retained.
ShareRetentionPolicy	setEnabled(boolean enabled)	Set the enabled property: Indicates whether a retention policy is enabled for the File service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShareRetentionPolicy

public ShareRetentionPolicy()

Method Detail

isEnabled

public boolean isEnabled()

Get the enabled property: Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.

Returns:

the enabled value.

setEnabled

public ShareRetentionPolicy setEnabled(boolean enabled)

Set the enabled property: Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.

Parameters:

enabled - the enabled value to set.

Returns:

the ShareRetentionPolicy object itself.

getDays

public Integer getDays()

Get the days property: Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.

Returns:

the days value.

setDays

public ShareRetentionPolicy setDays(Integer days)

Set the days property: Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.

Parameters:

days - the days value to set.

Returns:

the ShareRetentionPolicy object itself.