DataLakePathScheduleDeletionOptions Class

  • java.lang.Object
    • com.azure.storage.file.datalake.options.DataLakePathScheduleDeletionOptions

public class DataLakePathScheduleDeletionOptions

Extended access options that may be passed to set when scheduling deletion for a path. Note: can only set either ExpiresOn value or TimeToExpire value, cannot set both.

Constructor Summary

Constructor Description
DataLakePathScheduleDeletionOptions(Duration timeToExpire)

Optional parameters for scheduling the deletion of a path.

DataLakePathScheduleDeletionOptions(OffsetDateTime expiresOn)

Optional parameters for scheduling the deletion of a path.

Method Summary

Modifier and Type Method and Description
OffsetDateTime getExpiresOn()
Duration getTimeToExpire()

Methods inherited from java.lang.Object

Constructor Details

DataLakePathScheduleDeletionOptions

public DataLakePathScheduleDeletionOptions(Duration timeToExpire)

Optional parameters for scheduling the deletion of a path.

Parameters:

timeToExpire - Duration before file should be deleted. Note: Does not apply to directories.

DataLakePathScheduleDeletionOptions

public DataLakePathScheduleDeletionOptions(OffsetDateTime expiresOn)

Optional parameters for scheduling the deletion of a path.

Parameters:

expiresOn - OffsetDateTimeto set for when the file will be deleted. If null, the existing expiresOn time on the file will be removed, if it exists. Note: Does not apply to directories.

Method Details

getExpiresOn

public OffsetDateTime getExpiresOn()

Returns:

the expiry date.

getTimeToExpire

public Duration getTimeToExpire()

Returns:

the time to expire.

Applies to