org.apache.hadoop.fs.s3a

Enum S3AInputPolicy

java.lang.Object

java.lang.Enum<S3AInputPolicy>

org.apache.hadoop.fs.s3a.S3AInputPolicy

All Implemented Interfaces:

Serializable, Comparable<S3AInputPolicy>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public enum S3AInputPolicy
extends Enum<S3AInputPolicy>

Stream input policy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Normal
Random
Sequential

Method Summary

Modifier and Type	Method and Description
static S3AInputPolicy	getFirstSupportedPolicy(Collection<String> policies, S3AInputPolicy defaultPolicy) Scan the list of input policies, returning the first one supported.
static S3AInputPolicy	getPolicy(String name, S3AInputPolicy defaultPolicy) Choose an access policy.
String	toString()
static S3AInputPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static S3AInputPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Normal

public static final S3AInputPolicy Normal

Random

public static final S3AInputPolicy Random

Sequential

public static final S3AInputPolicy Sequential

Method Detail

values

public static S3AInputPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (S3AInputPolicy c : S3AInputPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static S3AInputPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<S3AInputPolicy>

getPolicy

public static S3AInputPolicy getPolicy(String name,
                                       @Nullable
                                       S3AInputPolicy defaultPolicy)

Choose an access policy.

Parameters:

name - strategy name from a configuration option, etc.

defaultPolicy - default policy to fall back to.

Returns:

the chosen strategy

getFirstSupportedPolicy

public static S3AInputPolicy getFirstSupportedPolicy(Collection<String> policies,
                                                     @Nullable
                                                     S3AInputPolicy defaultPolicy)

Scan the list of input policies, returning the first one supported.

Parameters:

policies - list of policies.

defaultPolicy - fallback

Returns:

a policy or the defaultPolicy, which may be null