alluxio.client.file.options

Class CreateDirectoryOptions

java.lang.Object

alluxio.client.file.options.CreateDirectoryOptions

@PublicApi
 @NotThreadSafe
public final class CreateDirectoryOptions
extends Object

Method options for creating a directory.

Method Summary

Modifier and Type	Method and Description
static CreateDirectoryOptions	defaults()
boolean	equals(Object o)
CommonOptions	getCommonOptions()
Mode	getMode()
long	getTtl()
TtlAction	getTtlAction()
WriteType	getWriteType()
int	hashCode()
boolean	isAllowExists()
boolean	isRecursive()
CreateDirectoryOptions	setAllowExists(boolean allowExists)
CreateDirectoryOptions	setCommonOptions(CommonOptions options)
CreateDirectoryOptions	setMode(Mode mode)
CreateDirectoryOptions	setRecursive(boolean recursive)
CreateDirectoryOptions	setTtl(long ttl)
CreateDirectoryOptions	setTtlAction(TtlAction ttlAction)
CreateDirectoryOptions	setWriteType(WriteType writeType)
String	toString()
CreateDirectoryTOptions	toThrift()

Methods inherited from class java.lang.Object

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

Method Detail

defaults

public static CreateDirectoryOptions defaults()

Returns:

the default CreateDirectoryOptions

getCommonOptions

public CommonOptions getCommonOptions()

Returns:

the common options

getMode

public Mode getMode()

Returns:

the mode of the directory to create

getWriteType

public WriteType getWriteType()

Returns:

the write type

isAllowExists

public boolean isAllowExists()

Returns:

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

getTtl

public long getTtl()

Returns:

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

getTtlAction

public TtlAction getTtlAction()

Returns:

the TtlAction

isRecursive

public boolean isRecursive()

Returns:

the recursive flag value; it specifies whether parent directories should be created if they do not already exist

setCommonOptions

public CreateDirectoryOptions setCommonOptions(CommonOptions options)

Parameters:

options - the common options

Returns:

the updated options object

setAllowExists

public CreateDirectoryOptions setAllowExists(boolean allowExists)

Parameters:

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

Returns:

the updated options object

setMode

public CreateDirectoryOptions setMode(Mode mode)

Parameters:

mode - the mode to be set

Returns:

the updated options object

setRecursive

public CreateDirectoryOptions setRecursive(boolean recursive)

Parameters:

recursive - the recursive flag value to use; it specifies whether parent directories should be created if they do not already exist

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, no matter whether the file is pinned

Returns:

the updated options object

setTtlAction

public CreateDirectoryOptions setTtlAction(TtlAction ttlAction)

Parameters:

ttlAction - the TtlAction to use

Returns:

the updated options object

setWriteType

public CreateDirectoryOptions setWriteType(WriteType writeType)

Parameters:

writeType - the write type to use

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 CreateDirectoryTOptions toThrift()

Returns:

Thrift representation of the options