ClusterDescription (Slider Core 0.90.2-incubating API)

java.lang.Object
- org.apache.slider.api.ClusterDescription

All Implemented Interfaces:

Cloneable
```
public class ClusterDescription
extends Object
implements Cloneable
```
Represents a cluster specification; designed to be sendable over the wire and persisted in JSON by way of Jackson. When used in cluster status operations the info and statistics maps contain information about the cluster. As a wire format it is less efficient in both xfer and ser/deser than a binary format, but by having one unified format for wire and persistence, the code paths are simplified. This was the original single-file specification/model used in the Hoya precursor to Slider. Its now retained primarily as a way to publish the current state of the application, or at least a fraction thereof ... the larger set of information from the REST API is beyond the scope of this structure.

Field Summary

Fields
Modifier and Type	Field and Description
`Map<String,String>`	`clientProperties` List of key-value pairs to add to a client config to set up the client
`long`	`createTime` When was the cluster specification created? This is not the time a cluster was thawed; that will be in the `info` section.
`String`	`dataPath` This is where the data goes
`String`	`generatedConfigurationPath` URL path to the generated configuration
`Map<String,String>`	`info` cluster information This is only valid when querying the cluster status.
`Map<String,List<String>>`	`instances` Instances: role->count
`ApplicationLivenessInformation`	`liveness` Liveness information; the same as returned on the `live/liveness/` URL
`protected static org.slf4j.Logger`	`log`
`String`	`name` Name of the cluster
`Map<String,String>`	`options` cluster-specific options -to control both the Slider AM and the application that it deploys
`String`	`originConfigurationPath` URL path to the original configuration files; these are re-read when restoring a cluster
`Map<String,Map<String,String>>`	`roles` Role options, role -> option -> value
`int`	`state` State of the cluster
`static int`	`STATE_CREATED` Cluster created: 2
`static int`	`STATE_DESTROYED` destroyed
`static int`	`STATE_INCOMPLETE` Specification is incomplete & cannot be used: 0
`static int`	`STATE_LIVE` Live: 3
`static int`	`STATE_STOPPED` Stopped
`static int`	`STATE_SUBMITTED` Spec has been submitted: 1
`Map<String,Map<String,Integer>>`	`statistics` Statistics.
`Map<String,Object>`	`status` Status information
`String`	`type` Type of cluster
`long`	`updateTime` When was the cluster specification last updated
`String`	`version` version counter

Constructor Summary

Constructors
Constructor and Description

ClusterDescription()
Creator.

Constructors
Constructor and Description
`ClusterDescription()` Creator.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Shallow clone
`static ClusterDescription`	`copy(ClusterDescription source)` Make a deep copy of the class
`ClusterDescription`	`deepClone()` A deep clone of the spec.
`static ClusterDescription`	`fromFile(File jsonFile)` Convert from a JSON file
`static ClusterDescription`	`fromJson(String json)` Convert from JSON
`static ClusterDescription`	`fromStream(InputStream is)` Convert from input stream
`String`	`getApplicationHome()` HBase home: if non-empty defines where a copy of HBase is preinstalled
`String`	`getImagePath()` The path in HDFS where the HBase image is
`String`	`getInfo(String key)` Get an information string.
`boolean`	`getInfoBool(String key)` Get an information string.
`String`	`getMandatoryOption(String key)` Get a cluster option or value
`Map<String,String>`	`getMandatoryRole(String role)` Get a role whose presence is mandatory
`String`	`getMandatoryRoleOpt(String role, String option)` Get a mandatory role option
`int`	`getMandatoryRoleOptInt(String role, String option)` Get a mandatory integer role option
`String`	`getOption(String key, String defVal)` Get a cluster option or value
`boolean`	`getOptionBool(String option, boolean defVal)` Get an option as a boolean.
`int`	`getOptionInt(String option, int defVal)` Get an integer option; use `Integer.decode(String)` so as to take hex oct and bin values too.
`Map<String,String>`	`getOrAddRole(String role)` Get a role -adding it to the roleopts map if none with that name exists
`Map<String,String>`	`getRole(String role)` look up a role and return its options
`Set<String>`	`getRoleNames()`
`String`	`getRoleOpt(String role, String option, String defVal)` Get a role option
`int`	`getRoleOptInt(String role, String option, int defVal)` Get an integer role option; use `Integer.decode(String)` so as to take hex oct and bin values too.
`long`	`getRoleOptLong(String role, String option, long defVal)` Get an integer role option; use `Integer.decode(String)` so as to take hex oct and bin values too.
`int`	`getRoleResourceRequirement(String role, String option, int defVal, int maxVal)` Get the value of a role requirement (cores, RAM, etc).
`String`	`getZkHosts()`
`String`	`getZkPath()`
`boolean`	`isImagePathSet()` Query for the image path being set (non null/non empty)
`static ClusterDescription`	`load(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path)` Load from the filesystem
`void`	`save(File file)` Save a cluster description to the local filesystem
`void`	`save(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, boolean overwrite)` Save a cluster description to a hadoop filesystem
`void`	`setApplicationHome(String applicationHome)`
`void`	`setImagePath(String imagePath)` Set the path in HDFS where the HBase image is
`void`	`setInfo(String key, String value)` Set an information string.
`void`	`setInfoTime(String keyHumanTime, String keyMachineTime, long time)` Set the time for an information (human, machine) timestamp pair of fields.
`void`	`setOption(String option, boolean val)` Set a boolean option
`void`	`setOption(String option, int val)` Set an integer option -it's converted to a string before saving
`void`	`setOption(String key, String val)` Set a cluster option: a key val pair in the options {} section
`void`	`setOptionifUnset(String key, String val)` Set a cluster option if it is unset.
`void`	`setRoleOpt(String role, String option, int val)` Set an integer role option, creating the role if necessary
`void`	`setRoleOpt(String role, String option, Object val)` Set a role option of any object, using its string value.
`void`	`setRoleOpt(String role, String option, String val)` Set a role option, creating the role if necessary
`void`	`setZkHosts(String zkHosts)` Set the hosts for the ZK quorum
`void`	`setZkPath(String zkPath)`
`String`	`toJsonString()` Convert to a JSON string
`String`	`toString()`
`void`	`verifyOptionSet(String key)` Verify that an option is set: that is defined AND non-empty

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

- Field Detail
  - log
```
protected static final org.slf4j.Logger log
```
  - version
```
public String version
```
    version counter
  - name
```
public String name
```
    Name of the cluster
  - type
```
public String type
```
    Type of cluster
  - state
```
public int state
```
    State of the cluster
  - STATE_INCOMPLETE
```
public static final int STATE_INCOMPLETE
```
    Specification is incomplete & cannot be used: 0
    
    See Also:
    Constant Field Values
  - STATE_SUBMITTED
```
public static final int STATE_SUBMITTED
```
    Spec has been submitted: 1
    
    See Also:
    Constant Field Values
  - STATE_CREATED
```
public static final int STATE_CREATED
```
    Cluster created: 2
    
    See Also:
    Constant Field Values
  - STATE_LIVE
```
public static final int STATE_LIVE
```
    Live: 3
    
    See Also:
    Constant Field Values
  - STATE_STOPPED
```
public static final int STATE_STOPPED
```
    Stopped
    
    See Also:
    Constant Field Values
  - STATE_DESTROYED
```
public static final int STATE_DESTROYED
```
    destroyed
    
    See Also:
    Constant Field Values
  - createTime
```
public long createTime
```
    When was the cluster specification created? This is not the time a cluster was thawed; that will be in the info section.
  - updateTime
```
public long updateTime
```
    When was the cluster specification last updated
  - originConfigurationPath
```
public String originConfigurationPath
```
    URL path to the original configuration files; these are re-read when restoring a cluster
  - generatedConfigurationPath
```
public String generatedConfigurationPath
```
    URL path to the generated configuration
  - dataPath
```
public String dataPath
```
    This is where the data goes
  - options
```
public Map<String,String> options
```
    cluster-specific options -to control both the Slider AM and the application that it deploys
  - info
```
public Map<String,String> info
```
    cluster information This is only valid when querying the cluster status.
  - statistics
```
public Map<String,Map<String,Integer>> statistics
```
    Statistics. This is only relevant when querying the cluster status
  - instances
```
public Map<String,List<String>> instances
```
    Instances: role->count
  - roles
```
public Map<String,Map<String,String>> roles
```
    Role options, role -> option -> value
  - clientProperties
```
public Map<String,String> clientProperties
```
    List of key-value pairs to add to a client config to set up the client
  - status
```
public Map<String,Object> status
```
    Status information
  - liveness
```
public ApplicationLivenessInformation liveness
```
    Liveness information; the same as returned on the live/liveness/ URL
- Constructor Detail
  - ClusterDescription
```
public ClusterDescription()
```
    Creator.
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Shallow clone
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a shallow clone
    
    Throws:
    
    CloneNotSupportedException
  - deepClone
```
public ClusterDescription deepClone()
```
    A deep clone of the spec. This is done inefficiently with a ser/derser
    
    Returns:
    the cluster description
  - save
```
public void save(org.apache.hadoop.fs.FileSystem fs,
        org.apache.hadoop.fs.Path path,
        boolean overwrite)
          throws IOException
```
    Save a cluster description to a hadoop filesystem
    
    Parameters:
    fs - filesystem
    path - path
    overwrite - should any existing file be overwritten
    
    Throws:
    
    IOException - IO exception
  - save
```
public void save(File file)
          throws IOException
```
    Save a cluster description to the local filesystem
    
    Parameters:
    file - file
    
    Throws:
    
    IOException - IO excpetion
  - load
```
public static ClusterDescription load(org.apache.hadoop.fs.FileSystem fs,
                      org.apache.hadoop.fs.Path path)
                               throws IOException,
                                      org.codehaus.jackson.JsonParseException,
                                      org.codehaus.jackson.map.JsonMappingException
```
    Load from the filesystem
    
    Parameters:
    fs - filesystem
    path - path
    
    Returns:
    a loaded CD
    
    Throws:
    
    IOException - IO problems
    
    org.codehaus.jackson.JsonParseException
    
    org.codehaus.jackson.map.JsonMappingException
  - copy
```
public static ClusterDescription copy(ClusterDescription source)
```
    Make a deep copy of the class
    
    Parameters:
    source - source
    
    Returns:
    the copy
  - toJsonString
```
public String toJsonString()
                    throws IOException,
                           org.codehaus.jackson.JsonGenerationException,
                           org.codehaus.jackson.map.JsonMappingException
```
    Convert to a JSON string
    
    Returns:
    a JSON string description
    
    Throws:
    
    IOException - Problems mapping/writing the object
    
    org.codehaus.jackson.JsonGenerationException
    
    org.codehaus.jackson.map.JsonMappingException
  - fromJson
```
public static ClusterDescription fromJson(String json)
                                   throws IOException,
                                          org.codehaus.jackson.JsonParseException,
                                          org.codehaus.jackson.map.JsonMappingException
```
    Convert from JSON
    
    Parameters:
    json - input
    
    Returns:
    the parsed JSON
    
    Throws:
    
    IOException - IO
    
    org.codehaus.jackson.map.JsonMappingException - failure to map from the JSON to this class
    
    org.codehaus.jackson.JsonParseException
  - fromStream
```
public static ClusterDescription fromStream(InputStream is)
                                     throws IOException,
                                            org.codehaus.jackson.JsonParseException,
                                            org.codehaus.jackson.map.JsonMappingException
```
    Convert from input stream
    
    Parameters:
    is - input stream of cluster description
    
    Returns:
    the parsed JSON
    
    Throws:
    
    IOException - IO
    
    org.codehaus.jackson.map.JsonMappingException - failure to map from the JSON to this class
    
    org.codehaus.jackson.JsonParseException
  - fromFile
```
public static ClusterDescription fromFile(File jsonFile)
                                   throws IOException,
                                          org.codehaus.jackson.JsonParseException,
                                          org.codehaus.jackson.map.JsonMappingException
```
    Convert from a JSON file
    
    Parameters:
    jsonFile - input file
    
    Returns:
    the parsed JSON
    
    Throws:
    
    IOException - IO problems
    
    org.codehaus.jackson.map.JsonMappingException - failure to map from the JSON to this class
    
    org.codehaus.jackson.JsonParseException
  - setOption
```
public void setOption(String key,
             String val)
```
    Set a cluster option: a key val pair in the options {} section
    
    Parameters:
    key - key option name
    val - value option value
  - setOptionifUnset
```
public void setOptionifUnset(String key,
                    String val)
```
    Set a cluster option if it is unset. If it is already set, in the Cluster Description, it is left alone
    
    Parameters:
    key - key key to query/set
    val - value value
  - setOption
```
public void setOption(String option,
             int val)
```
    Set an integer option -it's converted to a string before saving
    
    Parameters:
    option - option name
    val - integer value
  - setOption
```
public void setOption(String option,
             boolean val)
```
    Set a boolean option
    
    Parameters:
    option - option name
    val - bool value
  - getOption
```
public String getOption(String key,
               String defVal)
```
    Get a cluster option or value
    
    Parameters:
    key - option key
    defVal - option val
    
    Returns:
    resolved value or default
  - getMandatoryOption
```
public String getMandatoryOption(String key)
                          throws BadConfigException
```
    Get a cluster option or value
    
    Parameters:
    key - mandatory key
    
    Returns:
    the value
    
    Throws:
    
    BadConfigException - if the option is missing
  - getOptionInt
```
public int getOptionInt(String option,
               int defVal)
```
    Get an integer option; use Integer.decode(String) so as to take hex oct and bin values too.
    
    Parameters:
    option - option name
    defVal - default value
    
    Returns:
    parsed value
    
    Throws:
    
    NumberFormatException - if the role could not be parsed.
  - verifyOptionSet
```
public void verifyOptionSet(String key)
                     throws BadConfigException
```
    Verify that an option is set: that is defined AND non-empty
    
    Parameters:
    key - key to verify
    
    Throws:
    
    BadConfigException
  - getOptionBool
```
public boolean getOptionBool(String option,
                    boolean defVal)
```
    Get an option as a boolean. Note that Boolean.valueOf(String) is used for parsing -its policy of what is true vs false applies.
    
    Parameters:
    option - name
    defVal - default
    
    Returns:
    the option.
  - getRoleOpt
```
public String getRoleOpt(String role,
                String option,
                String defVal)
```
    Get a role option
    
    Parameters:
    role - role to get from
    option - option name
    defVal - default value
    
    Returns:
    resolved value
  - getMandatoryRoleOpt
```
public String getMandatoryRoleOpt(String role,
                         String option)
                           throws BadConfigException
```
    Get a mandatory role option
    
    Parameters:
    role - role to get from
    option - option name
    
    Returns:
    resolved value
    
    Throws:
    
    BadConfigException - if the option is not defined
  - getMandatoryRoleOptInt
```
public int getMandatoryRoleOptInt(String role,
                         String option)
                           throws BadConfigException
```
    Get a mandatory integer role option
    
    Parameters:
    role - role to get from
    option - option name
    
    Returns:
    resolved value
    
    Throws:
    
    BadConfigException - if the option is not defined
  - getRole
```
public Map<String,String> getRole(String role)
```
    look up a role and return its options
    
    Parameters:
    role - role
    
    Returns:
    role mapping or null
  - getOrAddRole
```
public Map<String,String> getOrAddRole(String role)
```
    Get a role -adding it to the roleopts map if none with that name exists
    
    Parameters:
    role - role
    
    Returns:
    role mapping
  - getRoleNames
```
public Set<String> getRoleNames()
```
  - getMandatoryRole
```
public Map<String,String> getMandatoryRole(String role)
                                    throws BadConfigException
```
    Get a role whose presence is mandatory
    
    Parameters:
    role - role name
    
    Returns:
    the mapping
    
    Throws:
    
    BadConfigException - if the role is not there
  - getRoleOptInt
```
public int getRoleOptInt(String role,
                String option,
                int defVal)
```
    Get an integer role option; use Integer.decode(String) so as to take hex oct and bin values too.
    
    Parameters:
    role - role to get from
    option - option name
    defVal - default value
    
    Returns:
    parsed value
    
    Throws:
    
    NumberFormatException - if the role could not be parsed.
  - getRoleOptLong
```
public long getRoleOptLong(String role,
                  String option,
                  long defVal)
```
    Get an integer role option; use Integer.decode(String) so as to take hex oct and bin values too.
    
    Parameters:
    role - role to get from
    option - option name
    defVal - default value
    
    Returns:
    parsed value
    
    Throws:
    
    NumberFormatException - if the role could not be parsed.
  - setRoleOpt
```
public void setRoleOpt(String role,
              String option,
              String val)
```
    Set a role option, creating the role if necessary
    
    Parameters:
    role - role name
    option - option name
    val - value
  - setRoleOpt
```
public void setRoleOpt(String role,
              String option,
              int val)
```
    Set an integer role option, creating the role if necessary
    
    Parameters:
    role - role name
    option - option name
    val - integer value
  - setRoleOpt
```
public void setRoleOpt(String role,
              String option,
              Object val)
```
    Set a role option of any object, using its string value. This works for (Boxed) numeric values as well as other objects
    
    Parameters:
    role - role name
    option - option name
    val - non-null value
  - getRoleResourceRequirement
```
public int getRoleResourceRequirement(String role,
                             String option,
                             int defVal,
                             int maxVal)
```
    Get the value of a role requirement (cores, RAM, etc). These are returned as integers, but there is special handling of the string ResourceKeys.YARN_RESOURCE_MAX, which triggers the return of the maximum value.
    
    Parameters:
    role - role to get from
    option - option name
    defVal - default value
    maxVal - value to return if the max val is requested
    
    Returns:
    parsed value
    
    Throws:
    
    NumberFormatException - if the role could not be parsed.
  - setInfoTime
```
public void setInfoTime(String keyHumanTime,
               String keyMachineTime,
               long time)
```
    Set the time for an information (human, machine) timestamp pair of fields. The human time is the time in millis converted via the Date class.
    
    Parameters:
    keyHumanTime - name of human time key
    keyMachineTime - name of machine time
    time - timestamp
  - setInfo
```
public void setInfo(String key,
           String value)
```
    Set an information string. This is content that is only valid in status reports.
    
    Parameters:
    key - key
    value - string value
  - getInfo
```
public String getInfo(String key)
```
    Get an information string. This is content that is only valid in status reports.
    
    Parameters:
    key - key
    
    Returns:
    the value or null
  - getInfoBool
```
public boolean getInfoBool(String key)
```
    Get an information string. This is content that is only valid in status reports.
    
    Parameters:
    key - key
    
    Returns:
    the value or null
  - getZkHosts
```
public String getZkHosts()
                  throws BadConfigException
```
    Throws:
    
    BadConfigException
  - setZkHosts
```
public void setZkHosts(String zkHosts)
```
    Set the hosts for the ZK quorum
    
    Parameters:
    zkHosts - a comma separated list of hosts
  - getZkPath
```
public String getZkPath()
                 throws BadConfigException
```
    Throws:
    
    BadConfigException
  - setZkPath
```
public void setZkPath(String zkPath)
```
  - getApplicationHome
```
public String getApplicationHome()
```
    HBase home: if non-empty defines where a copy of HBase is preinstalled
  - setApplicationHome
```
public void setApplicationHome(String applicationHome)
```
  - getImagePath
```
public String getImagePath()
```
    The path in HDFS where the HBase image is
  - setImagePath
```
public void setImagePath(String imagePath)
```
    Set the path in HDFS where the HBase image is
  - isImagePathSet
```
public boolean isImagePathSet()
```
    Query for the image path being set (non null/non empty)
    
    Returns:
    true if there is a path in the image path option

Class ClusterDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

version

name

type

state

STATE_INCOMPLETE

STATE_SUBMITTED

STATE_CREATED

STATE_LIVE

STATE_STOPPED

STATE_DESTROYED

createTime

updateTime

originConfigurationPath

generatedConfigurationPath

dataPath

options

info

statistics

instances

roles

clientProperties

status

liveness

Constructor Detail

ClusterDescription

Method Detail

toString

clone

deepClone

save

save

load

copy

toJsonString

fromJson

fromStream

fromFile

setOption

setOptionifUnset

setOption

setOption

getOption

getMandatoryOption

getOptionInt

verifyOptionSet

getOptionBool

getRoleOpt

getMandatoryRoleOpt

getMandatoryRoleOptInt

getRole

getOrAddRole

getRoleNames

getMandatoryRole

getRoleOptInt

getRoleOptLong

setRoleOpt

setRoleOpt

setRoleOpt

getRoleResourceRequirement

setInfoTime

setInfo

getInfo

getInfoBool

getZkHosts

setZkHosts

getZkPath

setZkPath

getApplicationHome

setApplicationHome

getImagePath

setImagePath

isImagePathSet