DistCpConstants (Apache Hadoop Distributed Copy 3.4.1 API)

java.lang.Object
- org.apache.hadoop.tools.DistCpConstants

@InterfaceAudience.LimitedPrivate(value="Distcp support tools")
 @InterfaceStability.Evolving
public final class DistCpConstants
extends Object

Utility class to hold commonly used constants.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACLS_NOT_SUPPORTED`
`static String`	`CHECKSUM_MISMATCH_ERROR_MSG`
`static String`	`CLASS_INSTANTIATION_ERROR_MSG`
`static String`	`CONF_LABEL_APPEND`
`static String`	`CONF_LABEL_ATOMIC_COPY` Constants mapping to command line switches/input options
`static String`	`CONF_LABEL_BANDWIDTH_MB`
`static String`	`CONF_LABEL_BLOCKS_PER_CHUNK` DistCp Blocks Per Chunk: "distcp.blocks.per.chunk".
`static String`	`CONF_LABEL_COPY_BUFFER_SIZE`
`static String`	`CONF_LABEL_COPY_LISTING_CLASS`
`static String`	`CONF_LABEL_COPY_STRATEGY`
`static String`	`CONF_LABEL_DELETE_MISSING`
`static String`	`CONF_LABEL_DIFF`
`static String`	`CONF_LABEL_DIFF_COPY_LISTING_TRAVERSE_DIRECTORY`
`static String`	`CONF_LABEL_DIRECT_WRITE`
`static String`	`CONF_LABEL_DISTCP_JOB_ID` DistCp job id for consumers of the Disctp
`static String`	`CONF_LABEL_FILTERS_CLASS` DistCp Filter class override param.
`static String`	`CONF_LABEL_FILTERS_FILE`
`static String`	`CONF_LABEL_IGNORE_FAILURES`
`static String`	`CONF_LABEL_LISTING_FILE_PATH`
`static String`	`CONF_LABEL_LISTSTATUS_THREADS`
`static String`	`CONF_LABEL_LOG_PATH`
`static String`	`CONF_LABEL_MAX_CHUNKS_IDEAL`
`static String`	`CONF_LABEL_MAX_CHUNKS_TOLERABLE`
`static String`	`CONF_LABEL_MAX_MAPS`
`static String`	`CONF_LABEL_META_FOLDER`
`static String`	`CONF_LABEL_MIN_RECORDS_PER_CHUNK`
`static String`	`CONF_LABEL_OVERWRITE`
`static String`	`CONF_LABEL_PRESERVE_RAWXATTRS`
`static String`	`CONF_LABEL_PRESERVE_STATUS`
`static String`	`CONF_LABEL_RDIFF`
`static String`	`CONF_LABEL_SIMPLE_LISTING_FILESTATUS_SIZE`
`static String`	`CONF_LABEL_SIMPLE_LISTING_RANDOMIZE_FILES`
`static String`	`CONF_LABEL_SKIP_CRC`
`static String`	`CONF_LABEL_SOURCE_LISTING`
`static String`	`CONF_LABEL_SPLIT_RATIO`
`static String`	`CONF_LABEL_SYNC_FOLDERS`
`static String`	`CONF_LABEL_TARGET_FINAL_PATH`
`static String`	`CONF_LABEL_TARGET_PATH_EXISTS`
`static String`	`CONF_LABEL_TARGET_WORK_PATH`
`static String`	`CONF_LABEL_TOTAL_BYTES_TO_BE_COPIED`
`static String`	`CONF_LABEL_TOTAL_NUMBER_OF_RECORDS`
`static String`	`CONF_LABEL_TRACK_MISSING`
`static String`	`CONF_LABEL_UPDATE_MOD_TIME` Enabling `distcp -update` to use modification time of source and target file to check while copying same file with same size but different content.
`static boolean`	`CONF_LABEL_UPDATE_MOD_TIME_DEFAULT` Default value for 'distcp.update.modification.time' configuration.
`static String`	`CONF_LABEL_UPDATE_ROOT`
`static String`	`CONF_LABEL_USE_ITERATOR`
`static String`	`CONF_LABEL_VERBOSE_LOG`
`static String`	`CONF_LABEL_WORK_PATH`
`static int`	`COPY_BUFFER_SIZE_DEFAULT`
`static float`	`DEFAULT_BANDWIDTH_MB`
`static int`	`DEFAULT_LISTSTATUS_THREADS`
`static int`	`DEFAULT_MAPS`
`static String`	`DISTCP_EXCLUDE_FILE_REGEX` Distcp exclude file regex override param.
`static int`	`DUPLICATE_INPUT`
`static String`	`HDFS_RESERVED_RAW_DIRECTORY_NAME` Value of reserved raw HDFS directory when copying raw.* xattrs.
`static int`	`INVALID_ARGUMENT`
`static String`	`LENGTH_MISMATCH_ERROR_MSG`
`static int`	`MAX_CHUNKS_IDEAL_DEFAULT`
`static int`	`MAX_CHUNKS_TOLERABLE_DEFAULT` Constants for DistCp default values of configurable values
`static int`	`MIN_RECORDS_PER_CHUNK_DEFAULT`
`static org.apache.hadoop.fs.Path`	`NONE_PATH`
`static String`	`NONE_PATH_NAME` Constants for NONE file deletion
`static org.apache.hadoop.fs.Path`	`RAW_NONE_PATH`
`static String`	`SOURCE_SORTED_FILE` Filename of sorted files in when tracking saves them.
`static int`	`SPLIT_RATIO_DEFAULT`
`static int`	`SUCCESS` Constants for DistCp return code to shell / consumer of ToolRunner's run
`static String`	`TARGET_LISTING_FILE` Filename of unsorted target listing.
`static String`	`TARGET_SORTED_FILE` Filename of sorted target listing.
`static String`	`UNIFORMSIZE`
`static int`	`UNKNOWN_ERROR`
`static int`	`XATTRS_NOT_SUPPORTED`

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

- Field Detail
  - DEFAULT_LISTSTATUS_THREADS
```
public static final int DEFAULT_LISTSTATUS_THREADS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAPS
```
public static final int DEFAULT_MAPS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BANDWIDTH_MB
```
public static final float DEFAULT_BANDWIDTH_MB
```
    See Also:
    
    Constant Field Values
  - UNIFORMSIZE
```
public static final String UNIFORMSIZE
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_ATOMIC_COPY
```
public static final String CONF_LABEL_ATOMIC_COPY
```
    Constants mapping to command line switches/input options
    
    See Also:
    
    Constant Field Values
  - CONF_LABEL_WORK_PATH
```
public static final String CONF_LABEL_WORK_PATH
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_LOG_PATH
```
public static final String CONF_LABEL_LOG_PATH
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_VERBOSE_LOG
```
public static final String CONF_LABEL_VERBOSE_LOG
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_IGNORE_FAILURES
```
public static final String CONF_LABEL_IGNORE_FAILURES
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_PRESERVE_STATUS
```
public static final String CONF_LABEL_PRESERVE_STATUS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_PRESERVE_RAWXATTRS
```
public static final String CONF_LABEL_PRESERVE_RAWXATTRS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_SYNC_FOLDERS
```
public static final String CONF_LABEL_SYNC_FOLDERS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_DELETE_MISSING
```
public static final String CONF_LABEL_DELETE_MISSING
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_TRACK_MISSING
```
public static final String CONF_LABEL_TRACK_MISSING
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_LISTSTATUS_THREADS
```
public static final String CONF_LABEL_LISTSTATUS_THREADS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_MAX_MAPS
```
public static final String CONF_LABEL_MAX_MAPS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_SOURCE_LISTING
```
public static final String CONF_LABEL_SOURCE_LISTING
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_COPY_STRATEGY
```
public static final String CONF_LABEL_COPY_STRATEGY
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_SKIP_CRC
```
public static final String CONF_LABEL_SKIP_CRC
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_OVERWRITE
```
public static final String CONF_LABEL_OVERWRITE
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_APPEND
```
public static final String CONF_LABEL_APPEND
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_DIFF
```
public static final String CONF_LABEL_DIFF
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_RDIFF
```
public static final String CONF_LABEL_RDIFF
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_BANDWIDTH_MB
```
public static final String CONF_LABEL_BANDWIDTH_MB
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_SIMPLE_LISTING_FILESTATUS_SIZE
```
public static final String CONF_LABEL_SIMPLE_LISTING_FILESTATUS_SIZE
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_SIMPLE_LISTING_RANDOMIZE_FILES
```
public static final String CONF_LABEL_SIMPLE_LISTING_RANDOMIZE_FILES
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_FILTERS_FILE
```
public static final String CONF_LABEL_FILTERS_FILE
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_MAX_CHUNKS_TOLERABLE
```
public static final String CONF_LABEL_MAX_CHUNKS_TOLERABLE
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_MAX_CHUNKS_IDEAL
```
public static final String CONF_LABEL_MAX_CHUNKS_IDEAL
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_MIN_RECORDS_PER_CHUNK
```
public static final String CONF_LABEL_MIN_RECORDS_PER_CHUNK
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_SPLIT_RATIO
```
public static final String CONF_LABEL_SPLIT_RATIO
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_DIRECT_WRITE
```
public static final String CONF_LABEL_DIRECT_WRITE
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_UPDATE_ROOT
```
public static final String CONF_LABEL_UPDATE_ROOT
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_TOTAL_BYTES_TO_BE_COPIED
```
public static final String CONF_LABEL_TOTAL_BYTES_TO_BE_COPIED
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_TOTAL_NUMBER_OF_RECORDS
```
public static final String CONF_LABEL_TOTAL_NUMBER_OF_RECORDS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_LISTING_FILE_PATH
```
public static final String CONF_LABEL_LISTING_FILE_PATH
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_TARGET_WORK_PATH
```
public static final String CONF_LABEL_TARGET_WORK_PATH
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_TARGET_FINAL_PATH
```
public static final String CONF_LABEL_TARGET_FINAL_PATH
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_TARGET_PATH_EXISTS
```
public static final String CONF_LABEL_TARGET_PATH_EXISTS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_DISTCP_JOB_ID
```
public static final String CONF_LABEL_DISTCP_JOB_ID
```
    DistCp job id for consumers of the Disctp
    
    See Also:
    
    Constant Field Values
  - CONF_LABEL_META_FOLDER
```
public static final String CONF_LABEL_META_FOLDER
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_COPY_LISTING_CLASS
```
public static final String CONF_LABEL_COPY_LISTING_CLASS
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_DIFF_COPY_LISTING_TRAVERSE_DIRECTORY
```
public static final String CONF_LABEL_DIFF_COPY_LISTING_TRAVERSE_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_FILTERS_CLASS
```
public static final String CONF_LABEL_FILTERS_CLASS
```
    DistCp Filter class override param.
    
    See Also:
    
    Constant Field Values
  - DISTCP_EXCLUDE_FILE_REGEX
```
public static final String DISTCP_EXCLUDE_FILE_REGEX
```
    Distcp exclude file regex override param.
    
    See Also:
    
    Constant Field Values
  - CONF_LABEL_COPY_BUFFER_SIZE
```
public static final String CONF_LABEL_COPY_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_BLOCKS_PER_CHUNK
```
public static final String CONF_LABEL_BLOCKS_PER_CHUNK
```
    DistCp Blocks Per Chunk: "distcp.blocks.per.chunk".
    
    See Also:
    
    Constant Field Values
  - CONF_LABEL_USE_ITERATOR
```
public static final String CONF_LABEL_USE_ITERATOR
```
    See Also:
    
    Constant Field Values
  - CONF_LABEL_UPDATE_MOD_TIME
```
public static final String CONF_LABEL_UPDATE_MOD_TIME
```
    Enabling distcp -update to use modification time of source and target file to check while copying same file with same size but different content. The check would verify if the target file is perceived as older than the source then it indicates that the source has been recently updated and it is a newer version than what was synced, so we should not skip the copy. "distcp.update.modification.time"
    
    See Also:
    
    Constant Field Values
  - CONF_LABEL_UPDATE_MOD_TIME_DEFAULT
```
public static final boolean CONF_LABEL_UPDATE_MOD_TIME_DEFAULT
```
    Default value for 'distcp.update.modification.time' configuration.
    
    See Also:
    
    Constant Field Values
  - SUCCESS
```
public static final int SUCCESS
```
    Constants for DistCp return code to shell / consumer of ToolRunner's run
    
    See Also:
    
    Constant Field Values
  - INVALID_ARGUMENT
```
public static final int INVALID_ARGUMENT
```
    See Also:
    
    Constant Field Values
  - DUPLICATE_INPUT
```
public static final int DUPLICATE_INPUT
```
    See Also:
    
    Constant Field Values
  - ACLS_NOT_SUPPORTED
```
public static final int ACLS_NOT_SUPPORTED
```
    See Also:
    
    Constant Field Values
  - XATTRS_NOT_SUPPORTED
```
public static final int XATTRS_NOT_SUPPORTED
```
    See Also:
    
    Constant Field Values
  - UNKNOWN_ERROR
```
public static final int UNKNOWN_ERROR
```
    See Also:
    
    Constant Field Values
  - MAX_CHUNKS_TOLERABLE_DEFAULT
```
public static final int MAX_CHUNKS_TOLERABLE_DEFAULT
```
    Constants for DistCp default values of configurable values
    
    See Also:
    
    Constant Field Values
  - MAX_CHUNKS_IDEAL_DEFAULT
```
public static final int MAX_CHUNKS_IDEAL_DEFAULT
```
    See Also:
    
    Constant Field Values
  - MIN_RECORDS_PER_CHUNK_DEFAULT
```
public static final int MIN_RECORDS_PER_CHUNK_DEFAULT
```
    See Also:
    
    Constant Field Values
  - SPLIT_RATIO_DEFAULT
```
public static final int SPLIT_RATIO_DEFAULT
```
    See Also:
    
    Constant Field Values
  - NONE_PATH_NAME
```
public static final String NONE_PATH_NAME
```
    Constants for NONE file deletion
    
    See Also:
    
    Constant Field Values
  - NONE_PATH
```
public static final org.apache.hadoop.fs.Path NONE_PATH
```
  - RAW_NONE_PATH
```
public static final org.apache.hadoop.fs.Path RAW_NONE_PATH
```
  - HDFS_RESERVED_RAW_DIRECTORY_NAME
```
public static final String HDFS_RESERVED_RAW_DIRECTORY_NAME
```
    Value of reserved raw HDFS directory when copying raw.* xattrs.
    
    See Also:
    
    Constant Field Values
  - COPY_BUFFER_SIZE_DEFAULT
```
public static final int COPY_BUFFER_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - SOURCE_SORTED_FILE
```
public static final String SOURCE_SORTED_FILE
```
    Filename of sorted files in when tracking saves them.
    
    See Also:
    
    Constant Field Values
  - TARGET_LISTING_FILE
```
public static final String TARGET_LISTING_FILE
```
    Filename of unsorted target listing.
    
    See Also:
    
    Constant Field Values
  - TARGET_SORTED_FILE
```
public static final String TARGET_SORTED_FILE
```
    Filename of sorted target listing.
    
    See Also:
    
    Constant Field Values
  - LENGTH_MISMATCH_ERROR_MSG
```
public static final String LENGTH_MISMATCH_ERROR_MSG
```
    See Also:
    
    Constant Field Values
  - CHECKSUM_MISMATCH_ERROR_MSG
```
public static final String CHECKSUM_MISMATCH_ERROR_MSG
```
    See Also:
    
    Constant Field Values
  - CLASS_INSTANTIATION_ERROR_MSG
```
public static final String CLASS_INSTANTIATION_ERROR_MSG
```
    See Also:
    
    Constant Field Values

Class DistCpConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LISTSTATUS_THREADS

DEFAULT_MAPS

DEFAULT_BANDWIDTH_MB

UNIFORMSIZE

CONF_LABEL_ATOMIC_COPY

CONF_LABEL_WORK_PATH

CONF_LABEL_LOG_PATH

CONF_LABEL_VERBOSE_LOG

CONF_LABEL_IGNORE_FAILURES

CONF_LABEL_PRESERVE_STATUS

CONF_LABEL_PRESERVE_RAWXATTRS

CONF_LABEL_SYNC_FOLDERS

CONF_LABEL_DELETE_MISSING

CONF_LABEL_TRACK_MISSING

CONF_LABEL_LISTSTATUS_THREADS

CONF_LABEL_MAX_MAPS

CONF_LABEL_SOURCE_LISTING

CONF_LABEL_COPY_STRATEGY

CONF_LABEL_SKIP_CRC

CONF_LABEL_OVERWRITE

CONF_LABEL_APPEND

CONF_LABEL_DIFF

CONF_LABEL_RDIFF

CONF_LABEL_BANDWIDTH_MB

CONF_LABEL_SIMPLE_LISTING_FILESTATUS_SIZE

CONF_LABEL_SIMPLE_LISTING_RANDOMIZE_FILES

CONF_LABEL_FILTERS_FILE

CONF_LABEL_MAX_CHUNKS_TOLERABLE

CONF_LABEL_MAX_CHUNKS_IDEAL

CONF_LABEL_MIN_RECORDS_PER_CHUNK

CONF_LABEL_SPLIT_RATIO

CONF_LABEL_DIRECT_WRITE

CONF_LABEL_UPDATE_ROOT

CONF_LABEL_TOTAL_BYTES_TO_BE_COPIED

CONF_LABEL_TOTAL_NUMBER_OF_RECORDS

CONF_LABEL_LISTING_FILE_PATH

CONF_LABEL_TARGET_WORK_PATH

CONF_LABEL_TARGET_FINAL_PATH

CONF_LABEL_TARGET_PATH_EXISTS

CONF_LABEL_DISTCP_JOB_ID

CONF_LABEL_META_FOLDER

CONF_LABEL_COPY_LISTING_CLASS

CONF_LABEL_DIFF_COPY_LISTING_TRAVERSE_DIRECTORY

CONF_LABEL_FILTERS_CLASS

DISTCP_EXCLUDE_FILE_REGEX

CONF_LABEL_COPY_BUFFER_SIZE

CONF_LABEL_BLOCKS_PER_CHUNK

CONF_LABEL_USE_ITERATOR

CONF_LABEL_UPDATE_MOD_TIME

CONF_LABEL_UPDATE_MOD_TIME_DEFAULT

SUCCESS

INVALID_ARGUMENT

DUPLICATE_INPUT

ACLS_NOT_SUPPORTED

XATTRS_NOT_SUPPORTED

UNKNOWN_ERROR

MAX_CHUNKS_TOLERABLE_DEFAULT

MAX_CHUNKS_IDEAL_DEFAULT

MIN_RECORDS_PER_CHUNK_DEFAULT

SPLIT_RATIO_DEFAULT

NONE_PATH_NAME

NONE_PATH

RAW_NONE_PATH

HDFS_RESERVED_RAW_DIRECTORY_NAME

COPY_BUFFER_SIZE_DEFAULT

SOURCE_SORTED_FILE

TARGET_LISTING_FILE

TARGET_SORTED_FILE

LENGTH_MISMATCH_ERROR_MSG

CHECKSUM_MISMATCH_ERROR_MSG

CLASS_INSTANTIATION_ERROR_MSG