org.apache.hadoop.fs.s3a.tools

Class BucketTool

java.lang.Object

org.apache.hadoop.conf.Configured

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

org.apache.hadoop.fs.s3a.tools.BucketTool

All Implemented Interfaces:

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

public final class BucketTool
extends S3GuardTool

Bucket operations, e.g. create/delete/probe.

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	CREATE create command.
static String	NAME Name of this tool: "bucket".
static String	OPT_ENDPOINT endpoint "endpoint".
static String	OPT_REGION region "region".
static String	OPT_ZONE Zone for a store.
static String	PROBE_FAILURE Error Message logged/thrown when the tool could not start as the bucket probe was not disabled and the probe (inevitably) failed.
static String	PURPOSE Purpose of this tool: "View and manipulate S3 buckets".

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
BucketTool(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
String	getName() Return sub-command name.
String	getUsage()
static void	removeBucketOverrides(String bucket, org.apache.hadoop.conf.Configuration conf, String... options) Remove any values from a bucket.
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

NAME

public static final String NAME

Name of this tool: "bucket".

See Also:

Constant Field Values

PURPOSE

public static final String PURPOSE

Purpose of this tool: "View and manipulate S3 buckets".

See Also:

Constant Field Values

CREATE

public static final String CREATE

create command.

See Also:

Constant Field Values

OPT_REGION

public static final String OPT_REGION

region "region".

See Also:

Constant Field Values

OPT_ENDPOINT

public static final String OPT_ENDPOINT

endpoint "endpoint".

See Also:

Constant Field Values

OPT_ZONE

public static final String OPT_ZONE

Zone for a store.

See Also:

Constant Field Values

PROBE_FAILURE

public static final String PROBE_FAILURE

Error Message logged/thrown when the tool could not start as the bucket probe was not disabled and the probe (inevitably) failed.

See Also:

Constant Field Values

Constructor Detail

BucketTool

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

Method Detail

getUsage

public String getUsage()

Specified by:

getUsage in class S3GuardTool

getName

public String getName()

Description copied from class: S3GuardTool

Return sub-command name.

Specified by:

getName in class S3GuardTool

Returns:

sub-command name.

run

public int run(String[] args,
               PrintStream out)
        throws Exception,
               org.apache.hadoop.util.ExitUtil.ExitException

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:

Exception - on any failure

org.apache.hadoop.util.ExitUtil.ExitException

removeBucketOverrides

public static void removeBucketOverrides(String bucket,
                                         org.apache.hadoop.conf.Configuration conf,
                                         String... options)

Remove any values from a bucket.

Parameters:

bucket - bucket whose overrides are to be removed. Can be null/empty

conf - config

options - list of fs.s3a options to remove