alluxio.client.file.options

Class SetAttributeOptions

java.lang.Object

alluxio.client.file.options.SetAttributeOptions

@PublicApi
 @NotThreadSafe
public final class SetAttributeOptions
extends Object

Method options for setting any number of a path's attributes. If a value is set as null, it will be interpreted as an unset value and the current value will be unchanged.

Method Summary

Modifier and Type	Method and Description
static SetAttributeOptions	defaults()
boolean	equals(Object o)
CommonOptions	getCommonOptions()
String	getGroup()
Mode	getMode()
String	getOwner()
Boolean	getPersisted() Deprecated. the persisted attribute is deprecated since version 1.4 and will be removed in 2.0
Boolean	getPinned()
Long	getTtl()
TtlAction	getTtlAction()
int	hashCode()
boolean	isRecursive()
SetAttributeOptions	setCommonOptions(CommonOptions options)
SetAttributeOptions	setGroup(String group)
SetAttributeOptions	setMode(Mode mode)
SetAttributeOptions	setOwner(String owner)
SetAttributeOptions	setPersisted(boolean persisted) Deprecated. the persisted attribute is deprecated since version 1.4 and will be removed in 2.0
SetAttributeOptions	setPinned(boolean pinned)
SetAttributeOptions	setRecursive(boolean recursive) Sets the recursive flag.
SetAttributeOptions	setTtl(long ttl)
SetAttributeOptions	setTtlAction(TtlAction ttlAction)
String	toString()
SetAttributeTOptions	toThrift()

Methods inherited from class java.lang.Object

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

Method Detail

defaults

public static SetAttributeOptions defaults()

Returns:

the default SetAttributeOptions

getCommonOptions

public CommonOptions getCommonOptions()

Returns:

the common options

getPinned

public Boolean getPinned()

Returns:

the pinned flag value; it specifies whether the object should be kept in memory

getTtl

public Long getTtl()

Returns:

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, irrespective of whether the file is pinned

getTtlAction

public TtlAction getTtlAction()

Returns:

the TtlAction

getPersisted

@Deprecated
public Boolean getPersisted()

Deprecated. the persisted attribute is deprecated since version 1.4 and will be removed in 2.0

Returns:

the persisted value of the file; it denotes whether the file has been persisted to the under file system or not.

getOwner

public String getOwner()

Returns:

the owner

getGroup

public String getGroup()

Returns:

the group

getMode

public Mode getMode()

Returns:

the mode

isRecursive

public boolean isRecursive()

Returns:

the recursive flag value

setCommonOptions

public SetAttributeOptions setCommonOptions(CommonOptions options)

Parameters:

options - the common options

Returns:

the updated options object

setPinned

public SetAttributeOptions setPinned(boolean pinned)

Parameters:

pinned - the pinned flag value to use; it specifies whether the object should be kept in memory, if ttl(time to live) is set, the file will be deleted after expiration no matter this value is true or false

Returns:

the updated options object

setTtl

public SetAttributeOptions 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, irrespective of whether the file is pinned

Returns:

the updated options object

setTtlAction

public SetAttributeOptions setTtlAction(TtlAction ttlAction)

Parameters:

ttlAction - the TtlAction to use

Returns:

the updated options object

setPersisted

@Deprecated
public SetAttributeOptions setPersisted(boolean persisted)

Deprecated. the persisted attribute is deprecated since version 1.4 and will be removed in 2.0

Parameters:

persisted - the persisted flag value to use; it specifies whether the file has been persisted in the under file system or not.

Returns:

the updated options object

setOwner

public SetAttributeOptions setOwner(String owner)
                             throws IllegalArgumentException

Parameters:

owner - to be set as the owner of a path

Returns:

the updated options object

Throws:

IllegalArgumentException - if the owner is set to empty

setGroup

public SetAttributeOptions setGroup(String group)
                             throws IllegalArgumentException

Parameters:

group - to be set as the group of a path

Returns:

the updated options object

Throws:

IllegalArgumentException - if the group is set to empty

setMode

public SetAttributeOptions setMode(Mode mode)

Parameters:

mode - to be set as the mode of a path

Returns:

the updated options object

setRecursive

public SetAttributeOptions setRecursive(boolean recursive)

Sets the recursive flag.

Parameters:

recursive - whether to set acl recursively under a directory

Returns:

the updated options object

toThrift

public SetAttributeTOptions toThrift()

Returns:

Thrift representation of the options

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