alluxio.client.file.options

Class DeleteOptions

java.lang.Object

alluxio.client.file.options.DeleteOptions

@PublicApi
 @NotThreadSafe
public final class DeleteOptions
extends Object

Method options for deleting a file.

Method Summary

Modifier and Type	Method and Description
static DeleteOptions	defaults()
boolean	equals(Object o)
CommonOptions	getCommonOptions()
int	hashCode()
boolean	isAlluxioOnly()
boolean	isRecursive()
boolean	isUnchecked()
DeleteOptions	setAlluxioOnly(boolean alluxioOnly)
DeleteOptions	setCommonOptions(CommonOptions options)
DeleteOptions	setRecursive(boolean recursive)
DeleteOptions	setUnchecked(boolean unchecked)
String	toString()
DeleteTOptions	toThrift()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

defaults

public static DeleteOptions defaults()

Returns:

the default DeleteOptions

getCommonOptions

public CommonOptions getCommonOptions()

Returns:

the common options

isRecursive

public boolean isRecursive()

Returns:

the recursive flag value; if the object to be deleted is a directory, the flag specifies whether the directory content should be recursively deleted as well

isAlluxioOnly

public boolean isAlluxioOnly()

Returns:

return the value of the flag that indicates whether the file should be deleted in Alluxio only, or in UFS as well

isUnchecked

public boolean isUnchecked()

Returns:

if the UFS sync check should be skipped

setCommonOptions

public DeleteOptions setCommonOptions(CommonOptions options)

Parameters:

options - the common options

Returns:

the updated options object

setRecursive

public DeleteOptions setRecursive(boolean recursive)

Parameters:

recursive - the recursive flag value to use; if the object to be deleted is a directory, the flag specifies whether the directory content should be recursively deleted as well

Returns:

the updated options object

setAlluxioOnly

public DeleteOptions setAlluxioOnly(boolean alluxioOnly)

Parameters:

alluxioOnly - the value to use for the flag that indicates whether the file should be deleted in Alluxio only, or in UFS as well

Returns:

the updated options object

setUnchecked

public DeleteOptions setUnchecked(boolean unchecked)

Parameters:

unchecked - whether to skip UFS sync check

Returns:

the updated options object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toThrift

public DeleteTOptions toThrift()

Returns:

Thrift representation of the options