org.apache.hadoop.fs.s3a.impl

Class ConfigurationHelper

java.lang.Object

org.apache.hadoop.fs.s3a.impl.ConfigurationHelper

@InterfaceAudience.Private
public final class ConfigurationHelper
extends Object

Helper class for configuration; where methods related to extracting configuration should go instead of S3AUtils.

Method Summary

Modifier and Type	Method and Description
static Duration	enforceMinimumDuration(String name, Duration duration, Duration minimumDuration) Enforce a minimum duration of a configuration option, if the supplied value is non-null.
static Duration	getDuration(org.apache.hadoop.conf.Configuration conf, String name, Duration defaultDuration, TimeUnit defaultUnit, Duration minimumDuration) Get a duration.
static void	setDurationAsMillis(org.apache.hadoop.conf.Configuration conf, String name, Duration duration) Set a duration as a time in milliseconds, with the suffix "ms" added.
static void	setDurationAsSeconds(org.apache.hadoop.conf.Configuration conf, String name, Duration duration) Set a duration as a time in seconds, with the suffix "s" added.

Methods inherited from class java.lang.Object

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

Method Detail

getDuration

public static Duration getDuration(org.apache.hadoop.conf.Configuration conf,
                                   String name,
                                   Duration defaultDuration,
                                   TimeUnit defaultUnit,
                                   @Nullable
                                   Duration minimumDuration)

Get a duration. This may be negative; callers must check or set the minimum to zero. If the config option is greater than Integer.MAX_VALUE milliseconds, it is set to that max. If minimumDuration is set, and the value is less than that, then the minimum is used. Logs the value for diagnostics.

Parameters:

conf - config

name - option name

defaultDuration - default duration

defaultUnit - default unit on the config option if not declared.

minimumDuration - optional minimum duration;

Returns:

duration. may be negative.

setDurationAsSeconds

public static void setDurationAsSeconds(org.apache.hadoop.conf.Configuration conf,
                                        String name,
                                        Duration duration)

Set a duration as a time in seconds, with the suffix "s" added.

Parameters:

conf - configuration to update.

name - option name

duration - duration

setDurationAsMillis

public static void setDurationAsMillis(org.apache.hadoop.conf.Configuration conf,
                                       String name,
                                       Duration duration)

Set a duration as a time in milliseconds, with the suffix "ms" added.

Parameters:

conf - configuration to update.

name - option name

duration - duration

enforceMinimumDuration

public static Duration enforceMinimumDuration(String name,
                                              Duration duration,
                                              @Nullable
                                              Duration minimumDuration)

Enforce a minimum duration of a configuration option, if the supplied value is non-null.

Parameters:

name - option name

duration - duration to check

minimumDuration - minimum duration; may be null

Returns:

a duration which, if the minimum duration is set, is at least that value.