NeedsSyncCommand (Alluxio Shell 300 API)

java.lang.Object
- alluxio.cli.fs.command.AbstractFileSystemCommand
- - alluxio.cli.fs.command.NeedsSyncCommand

All Implemented Interfaces:

alluxio.cli.Command, java.io.Closeable, java.lang.AutoCloseable
```
@ThreadSafe
@PublicApi
public class NeedsSyncCommand
extends AbstractFileSystemCommand
```
Marks a path in Alluxio as needing metadata synchronization with the UFS. The next time the path or any child path is accessed a metadata sync for that path will be performed.

Field Summary
- Fields inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand
  mFileSystem, mFsContext

Constructor Summary

Constructors
Constructor Description

NeedsSyncCommand(alluxio.client.file.FileSystemContext fsContext)
Constructs a new instance of a needsSync command for the given Alluxio path.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getCommandName()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getUsage()`
`int`	`run(org.apache.commons.cli.CommandLine cl)`
`protected void`	`runPlainPath(alluxio.AlluxioURI plainPath, org.apache.commons.cli.CommandLine cl)`	Runs the command for a particular URI that does not contain wildcard in its path.
`void`	`validateArgs(org.apache.commons.cli.CommandLine cl)`

Methods inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand
processHeader, runWildCardCmd

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface alluxio.cli.Command
close, getOptions, getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail
- NeedsSyncCommand
```
public NeedsSyncCommand(alluxio.client.file.FileSystemContext fsContext)
```
  Constructs a new instance of a needsSync command for the given Alluxio path.
  
  Parameters:
  
  fsContext - the filesystem of Alluxio

Method Detail

getCommandName

public java.lang.String getCommandName()

runPlainPath
```
protected void runPlainPath(alluxio.AlluxioURI plainPath,
                            org.apache.commons.cli.CommandLine cl)
                     throws alluxio.exception.AlluxioException,
                            java.io.IOException
```
Description copied from class: AbstractFileSystemCommand

Runs the command for a particular URI that does not contain wildcard in its path.

Overrides:

runPlainPath in class AbstractFileSystemCommand

Parameters:

plainPath - an AlluxioURI that does not contain wildcard

cl - object containing the original commandLine

Throws:

alluxio.exception.AlluxioException

java.io.IOException

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws alluxio.exception.AlluxioException,
               java.io.IOException

Throws:: alluxio.exception.AlluxioException; java.io.IOException

getUsage
```
public java.lang.String getUsage()
```

getDescription

public java.lang.String getDescription()

validateArgs

public void validateArgs(org.apache.commons.cli.CommandLine cl)
                  throws alluxio.exception.status.InvalidArgumentException

Throws:: alluxio.exception.status.InvalidArgumentException