Package org.apache.hadoop.tools

Class DistCpOptions

java.lang.Object

org.apache.hadoop.tools.DistCpOptions

@Public
@Evolving
public final class DistCpOptions
extends java.lang.Object

The Options class encapsulates all DistCp options. When you add a new option, please: - Add the field along with javadoc in DistCpOptions and its Builder - Add setter method in the DistCpOptions.Builder class This class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistCpOptions.Builder	The builder of the DistCpOptions.
static class	DistCpOptions.FileAttribute	File attributes for preserve.

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_NUM_LISTSTATUS_THREADS

Method Summary

Modifier and Type	Method	Description
void	appendToConf(org.apache.hadoop.conf.Configuration conf)	Add options to configuration.
org.apache.hadoop.fs.Path	getAtomicWorkPath()
int	getBlocksPerChunk()
int	getCopyBufferSize()
java.lang.String	getCopyStrategy()
java.lang.String	getFiltersFile()
java.lang.String	getFromSnapshot()
org.apache.hadoop.fs.Path	getLogPath()
float	getMapBandwidth()
int	getMaxMaps()
int	getNumListstatusThreads()
java.util.Set<DistCpOptions.FileAttribute>	getPreserveAttributes()
org.apache.hadoop.fs.Path	getSourceFileListing()
java.util.List<org.apache.hadoop.fs.Path>	getSourcePaths()
org.apache.hadoop.fs.Path	getTargetPath()
java.lang.String	getToSnapshot()
org.apache.hadoop.fs.Path	getTrackPath()
boolean	shouldAppend()
boolean	shouldAtomicCommit()
boolean	shouldBlock()
boolean	shouldDeleteMissing()
boolean	shouldDirectWrite()
boolean	shouldIgnoreFailures()
boolean	shouldKeepLinks()
boolean	shouldListingCheck()
boolean	shouldOverwrite()
boolean	shouldPreserve(DistCpOptions.FileAttribute attribute)	Checks if the input attribute should be preserved or not.
boolean	shouldSkipCRC()
boolean	shouldSyncFolder()
boolean	shouldUpdateRoot()
boolean	shouldUseDiff()
boolean	shouldUseIterator()
boolean	shouldUseRdiff()
boolean	shouldUseSnapshotDiff()
boolean	shouldVerboseLog()
java.lang.String	toString()	Utility to easily string-ify Options, for logging.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NUM_LISTSTATUS_THREADS

public static final int MAX_NUM_LISTSTATUS_THREADS

See Also:

Constant Field Values

Method Detail

getSourceFileListing

public org.apache.hadoop.fs.Path getSourceFileListing()

getSourcePaths

public java.util.List<org.apache.hadoop.fs.Path> getSourcePaths()

getTargetPath

public org.apache.hadoop.fs.Path getTargetPath()

shouldAtomicCommit

public boolean shouldAtomicCommit()

getAtomicWorkPath

public org.apache.hadoop.fs.Path getAtomicWorkPath()

shouldSyncFolder

public boolean shouldSyncFolder()

shouldDeleteMissing

public boolean shouldDeleteMissing()

shouldIgnoreFailures

public boolean shouldIgnoreFailures()

shouldListingCheck

public boolean shouldListingCheck()

shouldOverwrite

public boolean shouldOverwrite()

shouldAppend

public boolean shouldAppend()

shouldSkipCRC

public boolean shouldSkipCRC()

shouldBlock

public boolean shouldBlock()

shouldUseDiff

public boolean shouldUseDiff()

shouldUseRdiff

public boolean shouldUseRdiff()

shouldUseSnapshotDiff

public boolean shouldUseSnapshotDiff()

getFromSnapshot

public java.lang.String getFromSnapshot()

getToSnapshot

public java.lang.String getToSnapshot()

getFiltersFile

public java.lang.String getFiltersFile()

getLogPath

public org.apache.hadoop.fs.Path getLogPath()

getCopyStrategy

public java.lang.String getCopyStrategy()

getNumListstatusThreads

public int getNumListstatusThreads()

getMaxMaps

public int getMaxMaps()

getMapBandwidth

public float getMapBandwidth()

getPreserveAttributes

public java.util.Set<DistCpOptions.FileAttribute> getPreserveAttributes()

shouldPreserve

public boolean shouldPreserve(DistCpOptions.FileAttribute attribute)

Checks if the input attribute should be preserved or not.

Parameters:

attribute - - Attribute to check

Returns:

True if attribute should be preserved, false otherwise

getBlocksPerChunk

public int getBlocksPerChunk()

getCopyBufferSize

public int getCopyBufferSize()

shouldVerboseLog

public boolean shouldVerboseLog()

getTrackPath

public org.apache.hadoop.fs.Path getTrackPath()

shouldDirectWrite

public boolean shouldDirectWrite()

shouldUseIterator

public boolean shouldUseIterator()

shouldUpdateRoot

public boolean shouldUpdateRoot()

shouldKeepLinks

public boolean shouldKeepLinks()

appendToConf

public void appendToConf(org.apache.hadoop.conf.Configuration conf)

Add options to configuration. These will be used in the Mapper/committer

Parameters:

conf - - Configuration object to which the options need to be added

toString

public java.lang.String toString()

Utility to easily string-ify Options, for logging.

Overrides:

toString in class java.lang.Object

Returns:

String representation of the Options.