org.apache.hadoop.fs.s3a.s3guard

Class S3GuardTool.BucketInfo

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

org.apache.hadoop.fs.s3a.s3guard.S3GuardTool.BucketInfo

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

Enclosing class:

S3GuardTool

public static class S3GuardTool.BucketInfo
extends S3GuardTool

Get info about a bucket and its S3Guard integration status.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

S3GuardTool.BucketInfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKET_INFO
static String	ENCRYPTION_FLAG
static String	FIPS_FLAG
static String	GUARDED_FLAG
static String	IS_MARKER_AWARE
static String	LOCATION_UNKNOWN Output when the client cannot get the location of a bucket.
static String	MAGIC_FLAG
static String	MARKERS_AWARE
static String	MARKERS_FLAG
static String	NAME
static String	PURPOSE
static String	UNGUARDED_FLAG

Fields inherited from class org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

AGE_OPTIONS_USAGE, DAYS_FLAG, HOURS_FLAG, META_FLAG, MINUTES_FLAG, SECONDS_FLAG, VERBOSE, WRONG_FILESYSTEM

Constructor Summary

Constructors

Constructor and Description
BucketInfo(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
String	getName() Return sub-command name.
String	getUsage()
int	run(String[] args, PrintStream out) Run the tool, capturing the output (if the tool supports that).

Methods inherited from class org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

addAgeOptions, badState, bindFilesystem, close, dumpFileSystemStatistics, errorln, errorln, exit, exitException, getCommandFormat, getFilesystem, initS3AFileSystem, invalidArgs, main, notFound, parseArgs, parseArgsWithErrorReporting, println, resetBindings, run, run, s3guardUnsupported, toUri, userAborted

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Field Detail

BUCKET_INFO

public static final String BUCKET_INFO

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

GUARDED_FLAG

public static final String GUARDED_FLAG

See Also:

Constant Field Values

UNGUARDED_FLAG

public static final String UNGUARDED_FLAG

See Also:

Constant Field Values

ENCRYPTION_FLAG

public static final String ENCRYPTION_FLAG

See Also:

Constant Field Values

MAGIC_FLAG

public static final String MAGIC_FLAG

See Also:

Constant Field Values

MARKERS_FLAG

public static final String MARKERS_FLAG

See Also:

Constant Field Values

MARKERS_AWARE

public static final String MARKERS_AWARE

See Also:

Constant Field Values

FIPS_FLAG

public static final String FIPS_FLAG

See Also:

Constant Field Values

PURPOSE

public static final String PURPOSE

See Also:

Constant Field Values

LOCATION_UNKNOWN

@VisibleForTesting
public static final String LOCATION_UNKNOWN

Output when the client cannot get the location of a bucket.

See Also:

Constant Field Values

IS_MARKER_AWARE

@VisibleForTesting
public static final String IS_MARKER_AWARE

See Also:

Constant Field Values

Constructor Detail

BucketInfo

public BucketInfo(org.apache.hadoop.conf.Configuration conf)

Method Detail

getName

public String getName()

Description copied from class: S3GuardTool

Return sub-command name.

Specified by:

getName in class S3GuardTool

Returns:

sub-command name.

getUsage

public String getUsage()

Specified by:

getUsage in class S3GuardTool

run

public int run(String[] args,
               PrintStream out)
        throws InterruptedException,
               IOException

Description copied from class: S3GuardTool

Run the tool, capturing the output (if the tool supports that). As well as returning an exit code, the implementations can choose to throw an instance of ExitUtil.ExitException with their exit code set to the desired exit value. The exit code of such an exception is used for the tool's exit code, and the stack trace only logged at debug.

Specified by:

run in class S3GuardTool

Parameters:

args - argument list

out - output stream

Returns:

the exit code to return.

Throws:

InterruptedException

IOException