DistCpOptions (Hadoop 1.2.2-SNAPSHOT API)

java.lang.Object
- org.apache.hadoop.tools.distcp2.DistCpOptions

```
public class DistCpOptions
extends Object
```
The Options class encapsulates all DistCp options. These may be set from command-line (via the OptionsParser) or may be set manually.

嵌套类概要

嵌套类
限定符和类型类和说明

static class DistCpOptions.FileAttribute

嵌套类
限定符和类型	类和说明
`static class`	`DistCpOptions.FileAttribute`

构造器概要

构造器
构造器和说明
`DistCpOptions(DistCpOptions that)` Copy constructor.
`DistCpOptions(List<Path> sourcePaths, Path targetPath)` Constructor, to initialize source/target paths.
`DistCpOptions(Path sourceFileListing, Path targetPath)` Constructor, to initialize source/target paths.

方法概要

方法
限定符和类型	方法和说明
`void`	`appendToConf(Configuration conf)` Add options to configuration.
`protected DistCpOptions`	`clone()`
`Path`	`getAtomicWorkPath()` Get work path for atomic commit.
`String`	`getCopyStrategy()` Get the copy strategy to use.
`Path`	`getLogPath()` Get output directory for writing distcp logs.
`int`	`getMapBandwidth()` Get the map bandwidth in MB
`int`	`getMaxMaps()` Get the max number of maps to use for this copy
`Path`	`getSourceFileListing()` File path (hdfs:// or file://) that contains the list of actual files to copy
`List<Path>`	`getSourcePaths()` Getter for sourcePaths.
`String`	`getSslConfigurationFile()` Get path where the ssl configuration file is present to use for hftps://
`Path`	`getTargetPath()` Getter for the targetPath.
`void`	`preserve(DistCpOptions.FileAttribute fileAttribute)` Add file attributes that need to be preserved.
`Iterator<DistCpOptions.FileAttribute>`	`preserveAttributes()` Returns an iterator with the list of file attributes to preserve
`void`	`setAtomicCommit(boolean atomicCommit)` Set if data need to be committed automatically
`void`	`setAtomicWorkPath(Path atomicWorkPath)` Set the work path for atomic commit
`void`	`setBlocking(boolean blocking)` Set if Disctp should run blocking or non-blocking
`void`	`setCopyStrategy(String copyStrategy)` Set the copy strategy to use.
`void`	`setDeleteMissing(boolean deleteMissing)` Set if files only present in target should be deleted
`void`	`setIgnoreFailures(boolean ignoreFailures)` Set if failures during copy be ignored
`void`	`setLogPath(Path logPath)` Set the log path where distcp output logs are stored Uses JobStagingDir/_logs by default
`void`	`setMapBandwidth(int mapBandwidth)` Set per map bandwidth
`void`	`setMaxMaps(int maxMaps)` Set the max number of maps to use for copy
`void`	`setOverwrite(boolean overwrite)` Set if files should always be overwritten on target
`void`	`setSkipCRC(boolean skipCRC)` Set if checksum comparison should be skipped while determining if source and destination files are identical
`void`	`setSourcePaths(List<Path> sourcePaths)` Setter for sourcePaths.
`void`	`setSslConfigurationFile(String sslConfigurationFile)` Set the SSL configuration file path to use with hftps:// (local path)
`void`	`setSyncFolder(boolean syncFolder)` Set if source and target folder contents be sync'ed up
`boolean`	`shouldAtomicCommit()` Should the data be committed atomically?
`boolean`	`shouldBlock()` Should DistCp be running in blocking mode
`boolean`	`shouldDeleteMissing()` Should target files missing in source should be deleted?
`boolean`	`shouldIgnoreFailures()` Should failures be logged and ignored during copy?
`boolean`	`shouldOverwrite()` Should files be overwritten always?
`boolean`	`shouldPreserve(DistCpOptions.FileAttribute attribute)` Checks if the input attibute should be preserved or not
`boolean`	`shouldSkipCRC()` Should CRC/checksum check be skipped while checking files are identical
`boolean`	`shouldSyncFolder()` Should the data be sync'ed between source and target paths?
`String`	`toString()` Utility to easily string-ify Options, for logging.
`void`	`validate(DistCpOptionSwitch option, boolean value)`

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - DistCpOptions
```
public DistCpOptions(List<Path> sourcePaths,
             Path targetPath)
```
    Constructor, to initialize source/target paths.
    
    参数:
    sourcePaths - List of source-paths (including wildcards) to be copied to target.
    targetPath - Destination path for the dist-copy.
  - DistCpOptions
```
public DistCpOptions(Path sourceFileListing,
             Path targetPath)
```
    Constructor, to initialize source/target paths.
    
    参数:
    sourceFileListing - File containing list of source paths
    targetPath - Destination path for the dist-copy.
  - DistCpOptions
```
public DistCpOptions(DistCpOptions that)
```
    Copy constructor.
    
    参数:
    that - DistCpOptions being copied from.
- 方法详细资料
  - shouldAtomicCommit
```
public boolean shouldAtomicCommit()
```
    Should the data be committed atomically?
    
    返回:
    true if data should be committed automically. false otherwise
  - setAtomicCommit
```
public void setAtomicCommit(boolean atomicCommit)
```
    Set if data need to be committed automatically
    
    参数:
    atomicCommit - - boolean switch
  - shouldSyncFolder
```
public boolean shouldSyncFolder()
```
    Should the data be sync'ed between source and target paths?
    
    返回:
    true if data should be sync'ed up. false otherwise
  - setSyncFolder
```
public void setSyncFolder(boolean syncFolder)
```
    Set if source and target folder contents be sync'ed up
    
    参数:
    syncFolder - - boolean switch
  - shouldDeleteMissing
```
public boolean shouldDeleteMissing()
```
    Should target files missing in source should be deleted?
    
    返回:
    true if zoombie target files to be removed. false otherwise
  - setDeleteMissing
```
public void setDeleteMissing(boolean deleteMissing)
```
    Set if files only present in target should be deleted
    
    参数:
    deleteMissing - - boolean switch
  - shouldIgnoreFailures
```
public boolean shouldIgnoreFailures()
```
    Should failures be logged and ignored during copy?
    
    返回:
    true if failures are to be logged and ignored. false otherwise
  - setIgnoreFailures
```
public void setIgnoreFailures(boolean ignoreFailures)
```
    Set if failures during copy be ignored
    
    参数:
    ignoreFailures - - boolean switch
  - shouldBlock
```
public boolean shouldBlock()
```
    Should DistCp be running in blocking mode
    
    返回:
    true if should run in blocking, false otherwise
  - setBlocking
```
public void setBlocking(boolean blocking)
```
    Set if Disctp should run blocking or non-blocking
    
    参数:
    blocking - - boolean switch
  - shouldOverwrite
```
public boolean shouldOverwrite()
```
    Should files be overwritten always?
    
    返回:
    true if files in target that may exist before distcp, should always be overwritten. false otherwise
  - setOverwrite
```
public void setOverwrite(boolean overwrite)
```
    Set if files should always be overwritten on target
    
    参数:
    overwrite - - boolean switch
  - shouldSkipCRC
```
public boolean shouldSkipCRC()
```
    Should CRC/checksum check be skipped while checking files are identical
    
    返回:
    true if checksum check should be skipped while checking files are identical. false otherwise
  - setSkipCRC
```
public void setSkipCRC(boolean skipCRC)
```
    Set if checksum comparison should be skipped while determining if source and destination files are identical
    
    参数:
    skipCRC - - boolean switch
  - getMaxMaps
```
public int getMaxMaps()
```
    Get the max number of maps to use for this copy
    
    返回:
    Max number of maps
  - setMaxMaps
```
public void setMaxMaps(int maxMaps)
```
    Set the max number of maps to use for copy
    
    参数:
    maxMaps - - Number of maps
  - getMapBandwidth
```
public int getMapBandwidth()
```
    Get the map bandwidth in MB
    
    返回:
    Bandwidth in MB
  - setMapBandwidth
```
public void setMapBandwidth(int mapBandwidth)
```
    Set per map bandwidth
    
    参数:
    mapBandwidth - - per map bandwidth
  - getSslConfigurationFile
```
public String getSslConfigurationFile()
```
    Get path where the ssl configuration file is present to use for hftps://
    
    返回:
    Path on local file system
  - setSslConfigurationFile
```
public void setSslConfigurationFile(String sslConfigurationFile)
```
    Set the SSL configuration file path to use with hftps:// (local path)
    
    参数:
    sslConfigurationFile - - Local ssl config file path
  - preserveAttributes
```
public Iterator<DistCpOptions.FileAttribute> preserveAttributes()
```
    Returns an iterator with the list of file attributes to preserve
    
    返回:
    iterator of file attributes to preserve
  - shouldPreserve
```
public boolean shouldPreserve(DistCpOptions.FileAttribute attribute)
```
    Checks if the input attibute should be preserved or not
    
    参数:
    attribute - - Attribute to check
    
    返回:
    True if attribute should be preserved, false otherwise
  - preserve
```
public void preserve(DistCpOptions.FileAttribute fileAttribute)
```
    Add file attributes that need to be preserved. This method may be called multiple times to add attributes.
    
    参数:
    fileAttribute - - Attribute to add, one at a time
  - getAtomicWorkPath
```
public Path getAtomicWorkPath()
```
    Get work path for atomic commit. If null, the work path would be parentOf(targetPath) + "/._WIP_" + nameOf(targetPath)
    
    返回:
    Atomic work path on the target cluster. Null if not set
  - setAtomicWorkPath
```
public void setAtomicWorkPath(Path atomicWorkPath)
```
    Set the work path for atomic commit
    
    参数:
    atomicWorkPath - - Path on the target cluster
  - getLogPath
```
public Path getLogPath()
```
    Get output directory for writing distcp logs. Otherwise logs are temporarily written to JobStagingDir/_logs and deleted upon job completion
    
    返回:
    Log output path on the cluster where distcp job is run
  - setLogPath
```
public void setLogPath(Path logPath)
```
    Set the log path where distcp output logs are stored Uses JobStagingDir/_logs by default
    
    参数:
    logPath - - Path where logs will be saved
  - getCopyStrategy
```
public String getCopyStrategy()
```
    Get the copy strategy to use. Uses appropriate input format
    
    返回:
    copy strategy to use
  - setCopyStrategy
```
public void setCopyStrategy(String copyStrategy)
```
    Set the copy strategy to use. Should map to a strategy implementation in distp-default.xml
    
    参数:
    copyStrategy - - copy Strategy to use
  - getSourceFileListing
```
public Path getSourceFileListing()
```
    File path (hdfs:// or file://) that contains the list of actual files to copy
    
    返回:
    - Source listing file path
  - getSourcePaths
```
public List<Path> getSourcePaths()
```
    Getter for sourcePaths.
    
    返回:
    List of source-paths.
  - setSourcePaths
```
public void setSourcePaths(List<Path> sourcePaths)
```
    Setter for sourcePaths.
    
    参数:
    sourcePaths - The new list of source-paths.
  - getTargetPath
```
public Path getTargetPath()
```
    Getter for the targetPath.
    
    返回:
    The target-path.
  - validate
```
public void validate(DistCpOptionSwitch option,
            boolean value)
```
  - appendToConf
```
public void appendToConf(Configuration conf)
```
    Add options to configuration. These will be used in the Mapper/committer
    
    参数:
    conf - - Configruation object to which the options need to be added
  - toString
```
public String toString()
```
    Utility to easily string-ify Options, for logging.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    String representation of the Options.
  - clone
```
protected DistCpOptions clone()
                       throws CloneNotSupportedException
```
    覆盖:
    
    clone 在类中 Object
    
    抛出:
    
    CloneNotSupportedException

类 DistCpOptions

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DistCpOptions

DistCpOptions

DistCpOptions

方法详细资料

shouldAtomicCommit

setAtomicCommit

shouldSyncFolder

setSyncFolder

shouldDeleteMissing

setDeleteMissing

shouldIgnoreFailures

setIgnoreFailures

shouldBlock

setBlocking

shouldOverwrite

setOverwrite

shouldSkipCRC

setSkipCRC

getMaxMaps

setMaxMaps

getMapBandwidth

setMapBandwidth

getSslConfigurationFile

setSslConfigurationFile

preserveAttributes

shouldPreserve

preserve

getAtomicWorkPath

setAtomicWorkPath

getLogPath

setLogPath

getCopyStrategy

setCopyStrategy

getSourceFileListing

getSourcePaths

setSourcePaths

getTargetPath

validate

appendToConf

toString

clone