org.apache.hadoop.fs.s3a.tools

Class MarkerTool.ScanArgsBuilder

java.lang.Object

org.apache.hadoop.fs.s3a.tools.MarkerTool.ScanArgsBuilder

Enclosing class:

MarkerTool

public static final class MarkerTool.ScanArgsBuilder
extends Object

Builder of the scan arguments.

Constructor Summary

Constructors

Constructor and Description
ScanArgsBuilder()

Method Summary

Modifier and Type	Method and Description
MarkerTool.ScanArgs	build() Build the actual argument instance.
MarkerTool.ScanArgsBuilder	withDoPurge(boolean d) Should the markers be purged? This is also enabled when using the clean flag on the CLI.
MarkerTool.ScanArgsBuilder	withLimit(int l) Limit of files to scan; 0 for 'unlimited'.
MarkerTool.ScanArgsBuilder	withMaxMarkerCount(int max) Max marker count an audit must find (ignored on purge).
MarkerTool.ScanArgsBuilder	withMinMarkerCount(int min) Min marker count an audit must find (ignored on purge).
MarkerTool.ScanArgsBuilder	withNonAuth(boolean b) Consider only markers in non-authoritative paths as errors.
MarkerTool.ScanArgsBuilder	withPath(org.apache.hadoop.fs.Path p) Path to scan.
MarkerTool.ScanArgsBuilder	withSourceFS(org.apache.hadoop.fs.FileSystem source) Source FS; must be or wrap an S3A FS.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanArgsBuilder

public ScanArgsBuilder()

Method Detail

withSourceFS

public MarkerTool.ScanArgsBuilder withSourceFS(org.apache.hadoop.fs.FileSystem source)

Source FS; must be or wrap an S3A FS.

Parameters:

source - Source FileSystem

Returns:

the builder class after scanning source FS

withPath

public MarkerTool.ScanArgsBuilder withPath(org.apache.hadoop.fs.Path p)

Path to scan.

Parameters:

p - path to scan

Returns:

builder class for method chaining

withDoPurge

public MarkerTool.ScanArgsBuilder withDoPurge(boolean d)

Should the markers be purged? This is also enabled when using the clean flag on the CLI.

Parameters:

d - set to purge if true

Returns:

builder class for method chaining

withMinMarkerCount

public MarkerTool.ScanArgsBuilder withMinMarkerCount(int min)

Min marker count an audit must find (ignored on purge).

Parameters:

min - Minimum Marker Count (default 0)

Returns:

builder class for method chaining

withMaxMarkerCount

public MarkerTool.ScanArgsBuilder withMaxMarkerCount(int max)

Max marker count an audit must find (ignored on purge).

Parameters:

max - Maximum Marker Count (default 0)

Returns:

builder class for method chaining

withLimit

public MarkerTool.ScanArgsBuilder withLimit(int l)

Limit of files to scan; 0 for 'unlimited'.

Parameters:

l - Limit of files to scan

Returns:

builder class for method chaining

withNonAuth

public MarkerTool.ScanArgsBuilder withNonAuth(boolean b)

Consider only markers in non-authoritative paths as errors.

Parameters:

b - True if tool should only consider markers in non-authoritative paths

Returns:

builder class for method chaining

build

public MarkerTool.ScanArgs build()

Build the actual argument instance.

Returns:

the arguments to pass in