Package com.azure.storage.file.datalake.models

Class PathDeletedItem

java.lang.Object

com.azure.storage.file.datalake.models.PathDeletedItem

public class PathDeletedItem
extends Object

A path that has been soft deleted.

Constructor Summary

Constructors

Constructor	Description
PathDeletedItem(String path, boolean isPrefix, String deletionId, OffsetDateTime deletedOn, Integer remainingRetentionDays)	Constructs a PathDeletedItem.

Method Summary

Modifier and Type	Method	Description
OffsetDateTime	getDeletedOn()	Gets when the path was deleted.
String	getDeletionId()	Gets the deletion id associated with the deleted path to uniquely identify it from other items deleted at this path.
String	getPath()	Gets the name of the path.
Integer	getRemainingRetentionDays()	Gets the number of days left before the soft deleted path will be permanently deleted.
boolean	isPrefix()	Gets whether the item is a prefix.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathDeletedItem

public PathDeletedItem(String path,
                       boolean isPrefix,
                       String deletionId,
                       OffsetDateTime deletedOn,
                       Integer remainingRetentionDays)

Constructs a PathDeletedItem.

Parameters:

path - The name of the path

isPrefix - Whether the item is a prefix

deletionId - The deletion id associated with the deleted path to uniquely identify it from other items deleted at this path

deletedOn - When the path was deleted

remainingRetentionDays - The number of days left before the soft deleted path will be permanently deleted

Method Detail

getPath

public String getPath()

Gets the name of the path.

Returns:

the name of the path

isPrefix

public boolean isPrefix()

Gets whether the item is a prefix.

Returns:

whether the item is a prefix

getDeletionId

public String getDeletionId()

Gets the deletion id associated with the deleted path to uniquely identify it from other items deleted at this path.

Returns:

the deletion id

getDeletedOn

public OffsetDateTime getDeletedOn()

Gets when the path was deleted.

Returns:

when the path was deleted

getRemainingRetentionDays

public Integer getRemainingRetentionDays()

Gets the number of days left before the soft deleted path will be permanently deleted.

Returns:

the number of days before permanent deletion