alluxio.master.file.options

Class CreateFileOptions

java.lang.Object

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

alluxio.master.file.options.CreateFileOptions

@NotThreadSafe
public final class CreateFileOptions
extends CreatePathOptions<CreateFileOptions>

Method options for creating a file.

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
CreateFileOptions(CreateFileTOptions options) Constructs an instance of CreateFileOptions from CreateFileTOptions.

Method Summary

Modifier and Type	Method and Description
static CreateFileOptions	defaults()
boolean	equals(Object o)
long	getBlockSizeBytes()
protected CreateFileOptions	getThis()
long	getTtl()
TtlAction	getTtlAction()
int	hashCode()
boolean	isCacheable()
CreateFileOptions	setBlockSizeBytes(long blockSizeBytes)
CreateFileOptions	setCacheable(boolean cacheable)
CreateFileOptions	setTtl(long ttl)
CreateFileOptions	setTtlAction(TtlAction ttlAction)
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

CreateFileOptions

public CreateFileOptions(CreateFileTOptions options)

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

Parameters:

options - the CreateFileTOptions to use

Method Detail

defaults

public static CreateFileOptions defaults()

Returns:

the default CreateFileOptions

getBlockSizeBytes

public long getBlockSizeBytes()

Returns:

the block size

isCacheable

public boolean isCacheable()

Returns:

true if file is cacheable

getTtl

public long getTtl()

Returns:

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

getTtlAction

public TtlAction getTtlAction()

Returns:

the TtlAction

setBlockSizeBytes

public CreateFileOptions setBlockSizeBytes(long blockSizeBytes)

Parameters:

blockSizeBytes - the block size to use

Returns:

the updated options object

setCacheable

public CreateFileOptions setCacheable(boolean cacheable)

Parameters:

cacheable - true if the file is cacheable, false otherwise

Returns:

the updated options object

setTtl

public CreateFileOptions setTtl(long ttl)

Parameters:

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

Returns:

the updated options object

setTtlAction

public CreateFileOptions setTtlAction(TtlAction ttlAction)

Parameters:

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

Returns:

the updated options object

getThis

protected CreateFileOptions getThis()

Specified by:

getThis in class CreatePathOptions<CreateFileOptions>

equals

public boolean equals(Object o)

Overrides:

equals in class CreatePathOptions<CreateFileOptions>

hashCode

public int hashCode()

Overrides:

hashCode in class CreatePathOptions<CreateFileOptions>

toString

public String toString()

Overrides:

toString in class Object