alluxio.master.file.options

Class CreateDirectoryOptions

java.lang.Object

alluxio.master.file.options.CreatePathOptions<CreateDirectoryOptions>

alluxio.master.file.options.CreateDirectoryOptions

@NotThreadSafe
public final class CreateDirectoryOptions
extends CreatePathOptions<CreateDirectoryOptions>

Method options for creating a directory.

Field Summary

Fields inherited from class alluxio.master.file.options.CreatePathOptions

mCommonOptions, mGroup, mMetadataLoad, mMode, mMountPoint, mOperationTimeMs, mOwner, mPersisted, mRecursive

Constructor Summary

Constructors

Constructor and Description
CreateDirectoryOptions(CreateDirectoryTOptions options) Constructs an instance of CreateDirectoryOptions from CreateDirectoryTOptions.

Method Summary

Modifier and Type	Method and Description
static CreateDirectoryOptions	defaults()
boolean	equals(Object o)
protected CreateDirectoryOptions	getThis()
long	getTtl()
TtlAction	getTtlAction()
UfsStatus	getUfsStatus()
int	hashCode()
boolean	isAllowExists()
CreateDirectoryOptions	setAllowExists(boolean allowExists)
CreateDirectoryOptions	setTtl(long ttl)
CreateDirectoryOptions	setTtlAction(TtlAction ttlAction)
CreateDirectoryOptions	setUfsStatus(UfsStatus ufsStatus)
String	toString()

Methods inherited from class alluxio.master.file.options.CreatePathOptions

getCommonOptions, getGroup, getMode, getOperationTimeMs, getOwner, isMetadataLoad, isMountPoint, isPersisted, isRecursive, setCommonOptions, setGroup, setMetadataLoad, setMode, setMountPoint, setOperationTimeMs, setOwner, setPersisted, setRecursive, toStringHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateDirectoryOptions

public CreateDirectoryOptions(CreateDirectoryTOptions options)

Constructs an instance of CreateDirectoryOptions from CreateDirectoryTOptions. The option of permission is constructed with the username obtained from thrift transport.

Parameters:

options - the CreateDirectoryTOptions to use

Method Detail

defaults

public static CreateDirectoryOptions defaults()

Returns:

the default CreateDirectoryOptions

isAllowExists

public boolean isAllowExists()

Returns:

the allowExists flag; it specifies whether an exception should be thrown if the object being made already exists

getTtl

public long getTtl()

Returns:

the TTL (time to live) value; it identifies duration (in seconds) the created directory should be kept around before it is automatically deleted or free

getTtlAction

public TtlAction getTtlAction()

Returns:

the TtlAction

getUfsStatus

public UfsStatus getUfsStatus()

Returns:

the UfsStatus

setAllowExists

public CreateDirectoryOptions setAllowExists(boolean allowExists)

Parameters:

allowExists - the allowExists flag value to use; it specifies whether an exception should be thrown if the object being made already exists.

Returns:

the updated options object

setTtl

public CreateDirectoryOptions setTtl(long ttl)

Parameters:

ttl - the TTL (time to live) value to use; it identifies duration (in milliseconds) the created directory should be kept around before it is automatically deleted

Returns:

the updated options object

setTtlAction

public CreateDirectoryOptions setTtlAction(TtlAction ttlAction)

Parameters:

ttlAction - the TtlAction; It informs the action to take when Ttl is expired;

Returns:

the updated options object

setUfsStatus

public CreateDirectoryOptions setUfsStatus(UfsStatus ufsStatus)

Parameters:

ufsStatus - the UfsStatus; It sets the optional ufsStatus as an optimization

Returns:

the updated options object

getThis

protected CreateDirectoryOptions getThis()

Specified by:

getThis in class CreatePathOptions<CreateDirectoryOptions>

equals

public boolean equals(Object o)

Overrides:

equals in class CreatePathOptions<CreateDirectoryOptions>

hashCode

public int hashCode()

Overrides:

hashCode in class CreatePathOptions<CreateDirectoryOptions>

toString

public String toString()

Overrides:

toString in class Object