Package org.apache.hadoop.tools

Class DistCpOptions.Builder

java.lang.Object

org.apache.hadoop.tools.DistCpOptions.Builder

Enclosing class:

DistCpOptions

public static class DistCpOptions.Builder
extends java.lang.Object

The builder of the DistCpOptions. This is designed to be the only public interface to create a DistCpOptions object for users. It follows a simple Builder design pattern.

Constructor Summary

Constructors

Constructor	Description
Builder(java.util.List<org.apache.hadoop.fs.Path> sourcePaths, org.apache.hadoop.fs.Path targetPath)
Builder(org.apache.hadoop.fs.Path sourceFileListing, org.apache.hadoop.fs.Path targetPath)

Method Summary

Modifier and Type	Method	Description
DistCpOptions	build()	This is the single entry point for constructing DistCpOptions objects.
DistCpOptions.Builder	maxMaps(int newMaxMaps)
DistCpOptions.Builder	preserve(java.lang.String attributes)
DistCpOptions.Builder	preserve(DistCpOptions.FileAttribute attribute)
DistCpOptions.Builder	withAppend(boolean newAppend)
DistCpOptions.Builder	withAtomicCommit(boolean newAtomicCommit)
DistCpOptions.Builder	withAtomicWorkPath(org.apache.hadoop.fs.Path newAtomicWorkPath)
DistCpOptions.Builder	withBlocking(boolean newBlocking)
DistCpOptions.Builder	withBlocksPerChunk(int newBlocksPerChunk)
DistCpOptions.Builder	withCopyBufferSize(int newCopyBufferSize)
DistCpOptions.Builder	withCopyStrategy(java.lang.String newCopyStrategy)
DistCpOptions.Builder	withCRC(boolean newSkipCRC)	Deprecated. Use withSkipCRC(boolean) instead.
DistCpOptions.Builder	withDeleteMissing(boolean newDeleteMissing)
DistCpOptions.Builder	withDirectWrite(boolean newDirectWrite)
DistCpOptions.Builder	withFiltersFile(java.lang.String newFiletersFile)
DistCpOptions.Builder	withIgnoreFailures(boolean newIgnoreFailures)
DistCpOptions.Builder	withKeepLinks(boolean keepLinks)
DistCpOptions.Builder	withListingCheck(boolean newListingCheck)
DistCpOptions.Builder	withLogPath(org.apache.hadoop.fs.Path newLogPath)
DistCpOptions.Builder	withMapBandwidth(float newMapBandwidth)
DistCpOptions.Builder	withNumListstatusThreads(int newNumListstatusThreads)
DistCpOptions.Builder	withOverwrite(boolean newOverwrite)
DistCpOptions.Builder	withSkipCRC(boolean newSkipCRC)	whether builder with crc.
DistCpOptions.Builder	withSyncFolder(boolean newSyncFolder)
DistCpOptions.Builder	withTrackMissing(org.apache.hadoop.fs.Path path)
DistCpOptions.Builder	withUpdateRoot(boolean updateRootAttrs)
DistCpOptions.Builder	withUseDiff(java.lang.String newFromSnapshot, java.lang.String newToSnapshot)
DistCpOptions.Builder	withUseIterator(boolean useItr)
DistCpOptions.Builder	withUseRdiff(java.lang.String newFromSnapshot, java.lang.String newToSnapshot)
DistCpOptions.Builder	withVerboseLog(boolean newVerboseLog)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.util.List<org.apache.hadoop.fs.Path> sourcePaths,
               org.apache.hadoop.fs.Path targetPath)

Builder

public Builder(org.apache.hadoop.fs.Path sourceFileListing,
               org.apache.hadoop.fs.Path targetPath)

Method Detail

build

public DistCpOptions build()

This is the single entry point for constructing DistCpOptions objects. Before a new DistCpOptions object is returned, it will set the dependent options, validate the option combinations. After constructing, the DistCpOptions instance is immutable.

withAtomicCommit

public DistCpOptions.Builder withAtomicCommit(boolean newAtomicCommit)

withAtomicWorkPath

public DistCpOptions.Builder withAtomicWorkPath(org.apache.hadoop.fs.Path newAtomicWorkPath)

withSyncFolder

public DistCpOptions.Builder withSyncFolder(boolean newSyncFolder)

withDeleteMissing

public DistCpOptions.Builder withDeleteMissing(boolean newDeleteMissing)

withIgnoreFailures

public DistCpOptions.Builder withIgnoreFailures(boolean newIgnoreFailures)

withListingCheck

public DistCpOptions.Builder withListingCheck(boolean newListingCheck)

withOverwrite

public DistCpOptions.Builder withOverwrite(boolean newOverwrite)

withAppend

public DistCpOptions.Builder withAppend(boolean newAppend)

withCRC

@Deprecated
public DistCpOptions.Builder withCRC(boolean newSkipCRC)

Deprecated.

Use withSkipCRC(boolean) instead.

whether builder with crc.

Parameters:

newSkipCRC - whether to skip crc check

Returns:

Builder object whether to skip crc check

withSkipCRC

public DistCpOptions.Builder withSkipCRC(boolean newSkipCRC)

whether builder with crc.

Parameters:

newSkipCRC - whether to skip crc check

Returns:

Builder object whether to skip crc check

withBlocking

public DistCpOptions.Builder withBlocking(boolean newBlocking)

withUseDiff

public DistCpOptions.Builder withUseDiff(java.lang.String newFromSnapshot,
                                         java.lang.String newToSnapshot)

withUseRdiff

public DistCpOptions.Builder withUseRdiff(java.lang.String newFromSnapshot,
                                          java.lang.String newToSnapshot)

withFiltersFile

public DistCpOptions.Builder withFiltersFile(java.lang.String newFiletersFile)

withLogPath

public DistCpOptions.Builder withLogPath(org.apache.hadoop.fs.Path newLogPath)

withTrackMissing

public DistCpOptions.Builder withTrackMissing(org.apache.hadoop.fs.Path path)

withCopyStrategy

public DistCpOptions.Builder withCopyStrategy(java.lang.String newCopyStrategy)

withMapBandwidth

public DistCpOptions.Builder withMapBandwidth(float newMapBandwidth)

withNumListstatusThreads

public DistCpOptions.Builder withNumListstatusThreads(int newNumListstatusThreads)

maxMaps

public DistCpOptions.Builder maxMaps(int newMaxMaps)

preserve

public DistCpOptions.Builder preserve(java.lang.String attributes)

preserve

public DistCpOptions.Builder preserve(DistCpOptions.FileAttribute attribute)

withBlocksPerChunk

public DistCpOptions.Builder withBlocksPerChunk(int newBlocksPerChunk)

withCopyBufferSize

public DistCpOptions.Builder withCopyBufferSize(int newCopyBufferSize)

withVerboseLog

public DistCpOptions.Builder withVerboseLog(boolean newVerboseLog)

withDirectWrite

public DistCpOptions.Builder withDirectWrite(boolean newDirectWrite)

withUseIterator

public DistCpOptions.Builder withUseIterator(boolean useItr)

withUpdateRoot

public DistCpOptions.Builder withUpdateRoot(boolean updateRootAttrs)

withKeepLinks

public DistCpOptions.Builder withKeepLinks(boolean keepLinks)