SparkConf (Spark 1.2.2 JavaDoc)

Object
- org.apache.spark.SparkConf

All Implemented Interfaces:

Cloneable, Logging
```
public class SparkConf
extends Object
implements scala.Cloneable, Logging
```
Configuration for a Spark application. Used to set various Spark parameters as key-value pairs.
Most of the time, you would create a SparkConf object with new SparkConf(), which will load values from any spark.* Java system properties set in your application as well. In this case, parameters you set directly on the SparkConf object take priority over system properties.
For unit tests, you can also call new SparkConf(false) to skip loading external settings and get the same configuration no matter what the system properties are.
All setter methods in this class support chaining. For example, you can write new SparkConf().setMaster("local").setAppName("My app").
Note that once a SparkConf object is passed to Spark, it is cloned and can no longer be modified by the user. Spark does not support modifying the configuration at runtime.

Constructor Summary

Constructors
Constructor and Description

SparkConf()
Create a SparkConf that loads defaults from system properties and the classpath

SparkConf(boolean loadDefaults)

Constructors
Constructor and Description
`SparkConf()` Create a SparkConf that loads defaults from system properties and the classpath
`SparkConf(boolean loadDefaults)`

Method Summary

Methods
Modifier and Type	Method and Description
`SparkConf`	`clone()` Copy this object
`boolean`	`contains(String key)` Does the configuration contain a given parameter?
`String`	`get(String key)` Get a parameter; throws a NoSuchElementException if it's not set
`String`	`get(String key, String defaultValue)` Get a parameter, falling back to a default if not set
`scala.collection.Seq<scala.Tuple2<String,String>>`	`getAkkaConf()` Get all akka conf variables set on this SparkConf
`scala.Tuple2<String,String>[]`	`getAll()` Get all parameters as a list of pairs
`String`	`getAppId()` Returns the Spark application id, valid in the Driver after TaskScheduler registration and from the start in the Executor.
`boolean`	`getBoolean(String key, boolean defaultValue)` Get a parameter as a boolean, falling back to a default if not set
`double`	`getDouble(String key, double defaultValue)` Get a parameter as a double, falling back to a default if not set
`String`	`getenv(String name)` By using this instead of System.getenv(), environment variables can be mocked in unit tests.
`scala.collection.Seq<scala.Tuple2<String,String>>`	`getExecutorEnv()` Get all executor environment variables set on this SparkConf
`int`	`getInt(String key, int defaultValue)` Get a parameter as an integer, falling back to a default if not set
`long`	`getLong(String key, long defaultValue)` Get a parameter as a long, falling back to a default if not set
`scala.Option<String>`	`getOption(String key)` Get a parameter as an Option
`static boolean`	`isAkkaConf(String name)` Return whether the given config is an akka config (e.g.
`static boolean`	`isExecutorStartupConf(String name)` Return whether the given config should be passed to an executor on start-up.
`static boolean`	`isSparkPortConf(String name)` Return true if the given config matches either `spark..port` or `spark.port.`.
`SparkConf`	`registerKryoClasses(Class<?>[] classes)` Use Kryo serialization and register the given set of classes with Kryo.
`SparkConf`	`remove(String key)` Remove a parameter from the configuration
`SparkConf`	`set(String key, String value)` Set a configuration variable.
`SparkConf`	`setAll(scala.collection.Traversable<scala.Tuple2<String,String>> settings)` Set multiple parameters together
`SparkConf`	`setAppName(String name)` Set a name for your application.
`SparkConf`	`setExecutorEnv(scala.collection.Seq<scala.Tuple2<String,String>> variables)` Set multiple environment variables to be used when launching executors.
`SparkConf`	`setExecutorEnv(String variable, String value)` Set an environment variable to be used when launching executors for this application.
`SparkConf`	`setExecutorEnv(scala.Tuple2<String,String>[] variables)` Set multiple environment variables to be used when launching executors.
`SparkConf`	`setIfMissing(String key, String value)` Set a parameter if it isn't already configured
`SparkConf`	`setJars(scala.collection.Seq<String> jars)` Set JAR files to distribute to the cluster.
`SparkConf`	`setJars(String[] jars)` Set JAR files to distribute to the cluster.
`SparkConf`	`setMaster(String master)` The master URL to connect to, such as "local" to run locally with one thread, "local[4]" to run locally with 4 cores, or "spark://master:7077" to run on a Spark standalone cluster.
`SparkConf`	`setSparkHome(String home)` Set the location where Spark is installed on worker nodes.
`String`	`toDebugString()` Return a string listing all keys and values, one per line.
`void`	`validateSettings()` Checks for illegal or deprecated config settings.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.Logging
initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

- Constructor Detail
  - SparkConf
```
public SparkConf(boolean loadDefaults)
```
  - SparkConf
```
public SparkConf()
```
    Create a SparkConf that loads defaults from system properties and the classpath
- Method Detail
  - isAkkaConf
```
public static boolean isAkkaConf(String name)
```
    Return whether the given config is an akka config (e.g. akka.actor.provider). Note that this does not include spark-specific akka configs (e.g. spark.akka.timeout).
  - isExecutorStartupConf
```
public static boolean isExecutorStartupConf(String name)
```
    Return whether the given config should be passed to an executor on start-up.
    Certain akka and authentication configs are required of the executor when it connects to the scheduler, while the rest of the spark configs can be inherited from the driver later.
  - isSparkPortConf
```
public static boolean isSparkPortConf(String name)
```
    Return true if the given config matches either spark.*.port or spark.port.*.
  - set
```
public SparkConf set(String key,
            String value)
```
    Set a configuration variable.
  - setMaster
```
public SparkConf setMaster(String master)
```
    The master URL to connect to, such as "local" to run locally with one thread, "local[4]" to run locally with 4 cores, or "spark://master:7077" to run on a Spark standalone cluster.
  - setAppName
```
public SparkConf setAppName(String name)
```
    Set a name for your application. Shown in the Spark web UI.
  - setJars
```
public SparkConf setJars(scala.collection.Seq<String> jars)
```
    Set JAR files to distribute to the cluster.
  - setJars
```
public SparkConf setJars(String[] jars)
```
    Set JAR files to distribute to the cluster. (Java-friendly version.)
  - setExecutorEnv
```
public SparkConf setExecutorEnv(String variable,
                       String value)
```
    Set an environment variable to be used when launching executors for this application. These variables are stored as properties of the form spark.executorEnv.VAR_NAME (for example spark.executorEnv.PATH) but this method makes them easier to set.
  - setExecutorEnv
```
public SparkConf setExecutorEnv(scala.collection.Seq<scala.Tuple2<String,String>> variables)
```
    Set multiple environment variables to be used when launching executors. These variables are stored as properties of the form spark.executorEnv.VAR_NAME (for example spark.executorEnv.PATH) but this method makes them easier to set.
  - setExecutorEnv
```
public SparkConf setExecutorEnv(scala.Tuple2<String,String>[] variables)
```
    Set multiple environment variables to be used when launching executors. (Java-friendly version.)
  - setSparkHome
```
public SparkConf setSparkHome(String home)
```
    Set the location where Spark is installed on worker nodes.
  - setAll
```
public SparkConf setAll(scala.collection.Traversable<scala.Tuple2<String,String>> settings)
```
    Set multiple parameters together
  - setIfMissing
```
public SparkConf setIfMissing(String key,
                     String value)
```
    Set a parameter if it isn't already configured
  - registerKryoClasses
```
public SparkConf registerKryoClasses(Class<?>[] classes)
```
    Use Kryo serialization and register the given set of classes with Kryo. If called multiple times, this will append the classes from all calls together.
  - remove
```
public SparkConf remove(String key)
```
    Remove a parameter from the configuration
  - get
```
public String get(String key)
```
    Get a parameter; throws a NoSuchElementException if it's not set
  - get
```
public String get(String key,
         String defaultValue)
```
    Get a parameter, falling back to a default if not set
  - getOption
```
public scala.Option<String> getOption(String key)
```
    Get a parameter as an Option
  - getAll
```
public scala.Tuple2<String,String>[] getAll()
```
    Get all parameters as a list of pairs
  - getInt
```
public int getInt(String key,
         int defaultValue)
```
    Get a parameter as an integer, falling back to a default if not set
  - getLong
```
public long getLong(String key,
           long defaultValue)
```
    Get a parameter as a long, falling back to a default if not set
  - getDouble
```
public double getDouble(String key,
               double defaultValue)
```
    Get a parameter as a double, falling back to a default if not set
  - getBoolean
```
public boolean getBoolean(String key,
                 boolean defaultValue)
```
    Get a parameter as a boolean, falling back to a default if not set
  - getExecutorEnv
```
public scala.collection.Seq<scala.Tuple2<String,String>> getExecutorEnv()
```
    Get all executor environment variables set on this SparkConf
  - getAkkaConf
```
public scala.collection.Seq<scala.Tuple2<String,String>> getAkkaConf()
```
    Get all akka conf variables set on this SparkConf
  - getAppId
```
public String getAppId()
```
    Returns the Spark application id, valid in the Driver after TaskScheduler registration and from the start in the Executor.
  - contains
```
public boolean contains(String key)
```
    Does the configuration contain a given parameter?
  - clone
```
public SparkConf clone()
```
    Copy this object
    
    Overrides:
    
    clone in class Object
  - getenv
```
public String getenv(String name)
```
    By using this instead of System.getenv(), environment variables can be mocked in unit tests.
  - validateSettings
```
public void validateSettings()
```
    Checks for illegal or deprecated config settings. Throws an exception for the former. Not idempotent - may mutate this conf object to convert deprecated settings to supported ones.
  - toDebugString
```
public String toDebugString()
```
    Return a string listing all keys and values, one per line. This is useful to print the configuration out for debugging.

Class SparkConf

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface org.apache.spark.Logging

Constructor Detail

SparkConf

SparkConf

Method Detail

isAkkaConf

isExecutorStartupConf

isSparkPortConf

set

setMaster

setAppName

setJars

setJars

setExecutorEnv

setExecutorEnv

setExecutorEnv

setSparkHome

setAll

setIfMissing

registerKryoClasses

remove

get

get

getOption

getAll

getInt

getLong

getDouble

getBoolean

getExecutorEnv

getAkkaConf

getAppId

contains

clone

getenv

validateSettings

toDebugString