InstancedConfiguration (Alluxio Parent 2.5.1-SNAPSHOT API)

java.lang.Object
- alluxio.conf.InstancedConfiguration

All Implemented Interfaces:

AlluxioConfiguration

Direct Known Subclasses:

UnderFileSystemConfiguration
```
public class InstancedConfiguration
extends Object
implements AlluxioConfiguration
```
Alluxio configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`static AlluxioConfiguration`	`EMPTY_CONFIGURATION`
`protected AlluxioProperties`	`mProperties` Source of the truth of all property values (default or customized).

Constructor Summary

Constructors
Constructor and Description
`InstancedConfiguration(AlluxioConfiguration conf)` Creates a new instance of `InstancedConfiguration`.
`InstancedConfiguration(AlluxioProperties properties)` Creates a new instance of `InstancedConfiguration`.
`InstancedConfiguration(AlluxioProperties properties, boolean clusterDefaultsLoaded)` Creates a new instance of `InstancedConfiguration`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`clusterDefaultsLoaded()`
`AlluxioProperties`	`copyProperties()` Gets a copy of the `AlluxioProperties` which back the `AlluxioConfiguration`.
`static InstancedConfiguration`	`defaults()` Users should use this API to obtain a configuration for modification before passing to a FileSystem constructor.
`String`	`get(PropertyKey key)` Gets the value for the given key in the `Properties`; if this key is not found, a RuntimeException is thrown.
`String`	`get(PropertyKey key, ConfigurationValueOptions options)` Gets the value for the given key in the `Properties`; if this key is not found, a RuntimeException is thrown.
`boolean`	`getBoolean(PropertyKey key)` Gets the boolean representation of the value for the given key.
`long`	`getBytes(PropertyKey key)` Gets the bytes of the value for the given key.
`<T> Class<T>`	`getClass(PropertyKey key)` Gets the value for the given key as a class.
`double`	`getDouble(PropertyKey key)` Gets the double representation of the value for the given key.
`java.time.Duration`	`getDuration(PropertyKey key)` Gets the time of the key as a duration.
`<T extends Enum<T>> T`	`getEnum(PropertyKey key, Class<T> enumType)` Gets the value for the given key as an enum value.
`float`	`getFloat(PropertyKey key)` Gets the float representation of the value for the given key.
`int`	`getInt(PropertyKey key)` Gets the integer representation of the value for the given key.
`List<String>`	`getList(PropertyKey key, String delimiter)` Gets the value for the given key as a list.
`long`	`getLong(PropertyKey key)` Gets the long representation of the value for the given key.
`long`	`getMs(PropertyKey key)` Gets the time of key in millisecond unit.
`Map<String,String>`	`getNestedProperties(PropertyKey prefixKey)` Gets a set of properties that share a given common prefix key as a map.
`Source`	`getSource(PropertyKey key)`
`String`	`hash()`
`boolean`	`isSet(PropertyKey key)` Checks if the configuration contains a value for the given key.
`boolean`	`isSetByUser(PropertyKey key)`
`Set<PropertyKey>`	`keySet()`
`void`	`merge(Map<?,?> properties, Source source)` Merges map of properties into the current alluxio properties.
`void`	`set(PropertyKey key, Object value)` Sets the value for the appropriate key in the `Properties`.
`void`	`set(PropertyKey key, Object value, Source source)` Sets the value for the appropriate key in the `Properties` by source.
`Map<String,String>`	`toMap(ConfigurationValueOptions opts)`
`void`	`unset(PropertyKey key)` Unsets the value for the appropriate key in the `Properties`.
`Set<PropertyKey>`	`userKeySet()`
`void`	`validate()` Validates the configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface alluxio.conf.AlluxioConfiguration
getOrDefault, getOrDefault, toMap

- Field Detail
  - EMPTY_CONFIGURATION
```
public static final AlluxioConfiguration EMPTY_CONFIGURATION
```
  - mProperties
```
protected AlluxioProperties mProperties
```
    Source of the truth of all property values (default or customized).
- Constructor Detail
  - InstancedConfiguration
```
public InstancedConfiguration(AlluxioProperties properties)
```
    Creates a new instance of InstancedConfiguration. WARNING: This API is not intended to be used outside of internal Alluxio code and may be changed or removed in a future minor release. Application code should use defaults().
    
    Parameters:
    
    properties - alluxio properties underlying this configuration
  - InstancedConfiguration
```
public InstancedConfiguration(AlluxioProperties properties,
                              boolean clusterDefaultsLoaded)
```
    Creates a new instance of InstancedConfiguration. WARNING: This API is not intended to be used outside of internal Alluxio code and may be changed or removed in a future minor release. Application code should use defaults().
    
    Parameters:
    
    properties - alluxio properties underlying this configuration
    
    clusterDefaultsLoaded - Whether or not the properties represent the cluster defaults
  - InstancedConfiguration
```
public InstancedConfiguration(AlluxioConfiguration conf)
```
    Creates a new instance of InstancedConfiguration. WARNING: This API is not intended to be used outside of internal Alluxio code and may be changed or removed in a future minor release. Application code should use defaults().
    
    Parameters:
    
    conf - configuration to copy
- Method Detail
  - defaults
```
public static InstancedConfiguration defaults()
```
    Users should use this API to obtain a configuration for modification before passing to a FileSystem constructor. The default configuration contains all default configuration params and configuration properties modified in the alluxio-site.properties file. Example usage: InstancedConfiguration conf = InstancedConfiguration.defaults(); conf.set(...); FileSystem fs = FileSystem.Factory.create(conf); WARNING: This API is unstable and may be changed in a future minor release.
    
    Returns:
    
    an instanced configuration preset with defaults
  - copyProperties
```
public AlluxioProperties copyProperties()
```
    Description copied from interface: AlluxioConfiguration
    
    Gets a copy of the AlluxioProperties which back the AlluxioConfiguration.
    
    Specified by:
    
    copyProperties in interface AlluxioConfiguration
    
    Returns:
    
    the properties backing this configuration
  - get
```
public String get(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the value for the given key in the Properties; if this key is not found, a RuntimeException is thrown.
    
    Specified by:
    
    get in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key
  - get
```
public String get(PropertyKey key,
                  ConfigurationValueOptions options)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the value for the given key in the Properties; if this key is not found, a RuntimeException is thrown.
    
    Specified by:
    
    get in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    options - options for getting configuration value
    
    Returns:
    
    the value for the given key
  - isSet
```
public boolean isSet(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Checks if the configuration contains a value for the given key.
    
    Specified by:
    
    isSet in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to check
    
    Returns:
    
    true if there is value for the key, false otherwise
  - isSetByUser
```
public boolean isSetByUser(PropertyKey key)
```
    Specified by:
    
    isSetByUser in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to check
    
    Returns:
    
    true if there is value for the key set by user, false otherwise even when there is a default value for the key
  - set
```
public void set(PropertyKey key,
                Object value)
```
    Sets the value for the appropriate key in the Properties.
    
    Parameters:
    
    key - the key to set
    
    value - the value for the key
  - set
```
public void set(@Nonnull
                PropertyKey key,
                @Nonnull
                Object value,
                @Nonnull
                Source source)
```
    Sets the value for the appropriate key in the Properties by source.
    
    Parameters:
    
    key - the key to set
    
    value - the value for the key
    
    source - the source of the the properties (e.g., system property, default and etc)
  - unset
```
public void unset(PropertyKey key)
```
    Unsets the value for the appropriate key in the Properties. If the PropertyKey has a default value, it will still be considered set after executing this method.
    
    Parameters:
    
    key - the key to unset
  - merge
```
public void merge(Map<?,?> properties,
                  Source source)
```
    Merges map of properties into the current alluxio properties.
    
    Parameters:
    
    properties - map of keys to values
    
    source - the source type for these properties
  - keySet
```
public Set<PropertyKey> keySet()
```
    Specified by:
    
    keySet in interface AlluxioConfiguration
    
    Returns:
    
    the keys configured by the configuration
  - userKeySet
```
public Set<PropertyKey> userKeySet()
```
    Specified by:
    
    userKeySet in interface AlluxioConfiguration
    
    Returns:
    
    the keys set by user
  - getInt
```
public int getInt(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the integer representation of the value for the given key.
    
    Specified by:
    
    getInt in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as an int
  - getLong
```
public long getLong(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the long representation of the value for the given key.
    
    Specified by:
    
    getLong in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a long
  - getDouble
```
public double getDouble(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the double representation of the value for the given key.
    
    Specified by:
    
    getDouble in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a double
  - getFloat
```
public float getFloat(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the float representation of the value for the given key.
    
    Specified by:
    
    getFloat in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a float
  - getBoolean
```
public boolean getBoolean(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the boolean representation of the value for the given key.
    
    Specified by:
    
    getBoolean in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a boolean
  - getList
```
public List<String> getList(PropertyKey key,
                            String delimiter)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the value for the given key as a list.
    
    Specified by:
    
    getList in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    delimiter - the delimiter to split the values
    
    Returns:
    
    the list of values for the given key
  - getEnum
```
public <T extends Enum<T>> T getEnum(PropertyKey key,
                                     Class<T> enumType)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the value for the given key as an enum value.
    
    Specified by:
    
    getEnum in interface AlluxioConfiguration
    
    Type Parameters:
    
    T - the type of the enum
    
    Parameters:
    
    key - the key to get the value for
    
    enumType - the type of the enum
    
    Returns:
    
    the value for the given key as an enum value
  - getBytes
```
public long getBytes(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the bytes of the value for the given key.
    
    Specified by:
    
    getBytes in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the bytes of the value for the given key
  - getMs
```
public long getMs(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the time of key in millisecond unit.
    
    Specified by:
    
    getMs in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the time of key in millisecond unit
  - getDuration
```
public java.time.Duration getDuration(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the time of the key as a duration.
    
    Specified by:
    
    getDuration in interface AlluxioConfiguration
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value of the key represented as a duration
  - getClass
```
public <T> Class<T> getClass(PropertyKey key)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets the value for the given key as a class.
    
    Specified by:
    
    getClass in interface AlluxioConfiguration
    
    Type Parameters:
    
    T - the type of the class
    
    Parameters:
    
    key - the key to get the value for
    
    Returns:
    
    the value for the given key as a class
  - getNestedProperties
```
public Map<String,String> getNestedProperties(PropertyKey prefixKey)
```
    Description copied from interface: AlluxioConfiguration
    
    Gets a set of properties that share a given common prefix key as a map. E.g., if A.B=V1 and A.C=V2, calling this method with prefixKey=A returns a map of {B=V1, C=V2}, where B and C are also valid properties. If no property shares the prefix, an empty map is returned.
    
    Specified by:
    
    getNestedProperties in interface AlluxioConfiguration
    
    Parameters:
    
    prefixKey - the prefix key
    
    Returns:
    
    a map from nested properties aggregated by the prefix
  - getSource
```
public Source getSource(PropertyKey key)
```
    Specified by:
    
    getSource in interface AlluxioConfiguration
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the source for the given key
  - toMap
```
public Map<String,String> toMap(ConfigurationValueOptions opts)
```
    Specified by:
    
    toMap in interface AlluxioConfiguration
    
    Parameters:
    
    opts - options for formatting the configuration values
    
    Returns:
    
    a map from all configuration property names to their values; values may potentially be null
  - validate
```
public void validate()
```
    Description copied from interface: AlluxioConfiguration
    
    Validates the configuration.
    
    Specified by:
    
    validate in interface AlluxioConfiguration
  - clusterDefaultsLoaded
```
public boolean clusterDefaultsLoaded()
```
    Specified by:
    
    clusterDefaultsLoaded in interface AlluxioConfiguration
    
    Returns:
    
    whether or not the configuration has been merged with cluster defaults
  - hash
```
public String hash()
```
    Specified by:
    
    hash in interface AlluxioConfiguration
    
    Returns:
    
    hash of properties, if hashing is not supported, return empty string

Class InstancedConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface alluxio.conf.AlluxioConfiguration

Field Detail

EMPTY_CONFIGURATION

mProperties

Constructor Detail

InstancedConfiguration

InstancedConfiguration

InstancedConfiguration

Method Detail

defaults

copyProperties

get

get

isSet

isSetByUser

set

set

unset

merge

keySet

userKeySet

getInt

getLong

getDouble

getFloat

getBoolean

getList

getEnum

getBytes

getMs

getDuration

getClass

getNestedProperties

getSource

toMap

validate

clusterDefaultsLoaded

hash