Package com.azure.storage.file.datalake.options

Class FileScheduleDeletionOptions

java.lang.Object
com.azure.storage.file.datalake.options.FileScheduleDeletionOptions
public class FileScheduleDeletionOptions extends Object
Parameters for Schedule Deletion.

  • Constructor Details

    • FileScheduleDeletionOptions

      public FileScheduleDeletionOptions()
      Creates empty FileScheduleDeletionOptions. If the file was scheduled for deletion, the deletion will be cancelled.

    • FileScheduleDeletionOptions

      public FileScheduleDeletionOptions(Duration timeToExpire, FileExpirationOffset expiryRelativeTo)
      Sets time when the file will be deleted, relative to the file creation time or the current time.
      Parameters:
      timeToExpire - Duration before file will be deleted.
      expiryRelativeTo - Specifies if TimeToExpire should be set relative to the file's creation time, or the current time.
      Throws:
      NullPointerException - If timeToExpire or expiryRelativeTo is null.

    • FileScheduleDeletionOptions

      public FileScheduleDeletionOptions(OffsetDateTime expiresOn)
      Sets the OffsetDateTime when the file will be deleted.
      Parameters:
      expiresOn - The OffsetDateTime when the file will be deleted.
      Throws:
      NullPointerException - If expiresOn is null.

  • Method Details

    • getTimeToExpire

      public Duration getTimeToExpire()
      Gets the duration before the file will be deleted.
      Returns:
      Duration before file should be deleted.

    • getExpiryRelativeTo

      public FileExpirationOffset getExpiryRelativeTo()
      Gets the offset to set the expiry time relative to.
      Returns:
      if getTimeToExpire() should be set relative to the file's creation time, or the current time.

    • getExpiresOn

      public OffsetDateTime getExpiresOn()
      Gets the OffsetDateTime to set for when the file will be deleted.
      Returns:
      The OffsetDateTime to set for when the file will be deleted.