alluxio.cli.fs.command

Class FileSystemCommandUtils

java.lang.Object

alluxio.cli.fs.command.FileSystemCommandUtils

@ThreadSafe
 @PublicApi
public final class FileSystemCommandUtils
extends Object

Common util methods for executing commands.

Method Summary

Modifier and Type	Method and Description
static void	setDirectChildrenLoaded(FileSystem fs, AlluxioURI path, boolean directChildrenLoaded) Sets direct children loaded.
static void	setPinned(FileSystem fs, AlluxioURI path, boolean pinned, List<String> mediumTypes) Sets pin state for the input path.
static void	setTtl(FileSystem fs, AlluxioURI path, long ttlMs, TtlAction ttlAction) Sets a new TTL value or unsets an existing TTL value for file at path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setTtl

public static void setTtl(FileSystem fs,
                          AlluxioURI path,
                          long ttlMs,
                          TtlAction ttlAction)
                   throws AlluxioException,
                          IOException

Sets a new TTL value or unsets an existing TTL value for file at path.

Parameters:

fs - the file system for Alluxio

path - the file path

ttlMs - 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; Constants.NO_TTL means to unset the TTL value

ttlAction - Action to perform on Ttl expiry

Throws:

AlluxioException

IOException

setPinned

public static void setPinned(FileSystem fs,
                             AlluxioURI path,
                             boolean pinned,
                             List<String> mediumTypes)
                      throws AlluxioException,
                             IOException

Sets pin state for the input path.

Parameters:

fs - The FileSystem client

path - The AlluxioURI path as the input of the command

pinned - the state to be set

mediumTypes - a list of medium types to pin to

Throws:

AlluxioException

IOException

setDirectChildrenLoaded

public static void setDirectChildrenLoaded(FileSystem fs,
                                           AlluxioURI path,
                                           boolean directChildrenLoaded)
                                    throws AlluxioException,
                                           IOException

Sets direct children loaded.

Parameters:

fs - The FileSystem client

path - The AlluxioURI path as the input of the command

directChildrenLoaded - true or false

Throws:

AlluxioException

IOException