Packages

c

org.apache.spark

SparkConf

class SparkConf extends ReadOnlySparkConf with Cloneable with Logging with Serializable

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").

Source
SparkConf.scala
Note

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.

Linear Supertypes
Serializable, Logging, Cloneable, ReadOnlySparkConf, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparkConf
  2. Serializable
  3. Logging
  4. Cloneable
  5. ReadOnlySparkConf
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SparkConf()

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

  2. new SparkConf(loadDefaults: Boolean)

    loadDefaults

    whether to also load values from Java system properties

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    Logging

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def catchIllegalValue[T](key: String)(getValue: => T): T

    Wrapper method for get() methods which require some specific value format.

    Wrapper method for get() methods which require some specific value format. This catches any NumberFormatException or IllegalArgumentException and re-raises it with the incorrectly configured key in the exception message.

    Attributes
    protected
    Definition Classes
    ReadOnlySparkConf
  6. def clone(): SparkConf

    Copy this object

    Copy this object

    Definition Classes
    SparkConf → AnyRef
  7. def contains(key: String): Boolean

    Does the configuration contain a given parameter?

    Does the configuration contain a given parameter?

    Definition Classes
    SparkConf → ReadOnlySparkConf
  8. def contains(entry: ConfigEntry[_]): Boolean

    Does the configuration have the typed config entry?

    Does the configuration have the typed config entry?

    Definition Classes
    ReadOnlySparkConf
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def get(key: String, defaultValue: String): String

    Get a parameter, falling back to a default if not set

    Get a parameter, falling back to a default if not set

    Definition Classes
    ReadOnlySparkConf
  12. def get(key: String): String

    Get a parameter; throws a NoSuchElementException if it's not set

    Get a parameter; throws a NoSuchElementException if it's not set

    Definition Classes
    ReadOnlySparkConf
  13. def getAll: Array[(String, String)]

    Get all parameters as a list of pairs

    Get all parameters as a list of pairs

    Definition Classes
    SparkConf → ReadOnlySparkConf
  14. def getAllWithPrefix(prefix: String): Array[(String, String)]

    Get all parameters that start with prefix

  15. def getAppId: String

    Returns the Spark application id, valid in the Driver after TaskScheduler registration and from the start in the Executor.

  16. def getAvroSchema: Map[Long, String]

    Gets all the avro schemas in the configuration used in the generic Avro record serializer

  17. def getBoolean(key: String, defaultValue: Boolean): Boolean

    Get a parameter as a boolean, falling back to a default if not set

    Get a parameter as a boolean, falling back to a default if not set

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    IllegalArgumentException If the value cannot be interpreted as a boolean

  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. def getDouble(key: String, defaultValue: Double): Double

    Get a parameter as a double, falling back to a default if not ste

    Get a parameter as a double, falling back to a default if not ste

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as a double

  20. def getExecutorEnv: Seq[(String, String)]

    Get all executor environment variables set on this SparkConf

  21. def getInt(key: String, defaultValue: Int): Int

    Get a parameter as an integer, falling back to a default if not set

    Get a parameter as an integer, falling back to a default if not set

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as an integer

  22. def getLong(key: String, defaultValue: Long): Long

    Get a parameter as a long, falling back to a default if not set

    Get a parameter as a long, falling back to a default if not set

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as a long

  23. def getOption(key: String): Option[String]

    Get a parameter as an Option

    Get a parameter as an Option

    Definition Classes
    SparkConf → ReadOnlySparkConf
  24. def getSizeAsBytes(key: String, defaultValue: Long): Long

    Get a size parameter as bytes, falling back to a default if not set.

    Get a size parameter as bytes, falling back to a default if not set.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as bytes

  25. def getSizeAsBytes(key: String, defaultValue: String): Long

    Get a size parameter as bytes, falling back to a default if not set.

    Get a size parameter as bytes, falling back to a default if not set. If no suffix is provided then bytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as bytes

  26. def getSizeAsBytes(key: String): Long

    Get a size parameter as bytes; throws a NoSuchElementException if it's not set.

    Get a size parameter as bytes; throws a NoSuchElementException if it's not set. If no suffix is provided then bytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as bytes

    java.util.NoSuchElementException If the size parameter is not set

  27. def getSizeAsGb(key: String, defaultValue: String): Long

    Get a size parameter as Gibibytes, falling back to a default if not set.

    Get a size parameter as Gibibytes, falling back to a default if not set. If no suffix is provided then Gibibytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as Gibibytes

  28. def getSizeAsGb(key: String): Long

    Get a size parameter as Gibibytes; throws a NoSuchElementException if it's not set.

    Get a size parameter as Gibibytes; throws a NoSuchElementException if it's not set. If no suffix is provided then Gibibytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as Gibibytes

    java.util.NoSuchElementException If the size parameter is not set

  29. def getSizeAsKb(key: String, defaultValue: String): Long

    Get a size parameter as Kibibytes, falling back to a default if not set.

    Get a size parameter as Kibibytes, falling back to a default if not set. If no suffix is provided then Kibibytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as Kibibytes

  30. def getSizeAsKb(key: String): Long

    Get a size parameter as Kibibytes; throws a NoSuchElementException if it's not set.

    Get a size parameter as Kibibytes; throws a NoSuchElementException if it's not set. If no suffix is provided then Kibibytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as Kibibytes

    java.util.NoSuchElementException If the size parameter is not set

  31. def getSizeAsMb(key: String, defaultValue: String): Long

    Get a size parameter as Mebibytes, falling back to a default if not set.

    Get a size parameter as Mebibytes, falling back to a default if not set. If no suffix is provided then Mebibytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as Mebibytes

  32. def getSizeAsMb(key: String): Long

    Get a size parameter as Mebibytes; throws a NoSuchElementException if it's not set.

    Get a size parameter as Mebibytes; throws a NoSuchElementException if it's not set. If no suffix is provided then Mebibytes are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as Mebibytes

    java.util.NoSuchElementException If the size parameter is not set

  33. def getTimeAsMs(key: String, defaultValue: String): Long

    Get a time parameter as milliseconds, falling back to a default if not set.

    Get a time parameter as milliseconds, falling back to a default if not set. If no suffix is provided then milliseconds are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as milliseconds

  34. def getTimeAsMs(key: String): Long

    Get a time parameter as milliseconds; throws a NoSuchElementException if it's not set.

    Get a time parameter as milliseconds; throws a NoSuchElementException if it's not set. If no suffix is provided then milliseconds are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as milliseconds

    java.util.NoSuchElementException If the time parameter is not set

  35. def getTimeAsSeconds(key: String, defaultValue: String): Long

    Get a time parameter as seconds, falling back to a default if not set.

    Get a time parameter as seconds, falling back to a default if not set. If no suffix is provided then seconds are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as seconds

  36. def getTimeAsSeconds(key: String): Long

    Get a time parameter as seconds; throws a NoSuchElementException if it's not set.

    Get a time parameter as seconds; throws a NoSuchElementException if it's not set. If no suffix is provided then seconds are assumed.

    Definition Classes
    ReadOnlySparkConf
    Exceptions thrown

    NumberFormatException If the value cannot be interpreted as seconds

    java.util.NoSuchElementException If the time parameter is not set

  37. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  38. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  39. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  42. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  43. def logBasedOnLevel(level: Level)(f: => MessageWithContext): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  57. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  66. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  67. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  68. def registerAvroSchemas(schemas: Schema*): SparkConf

    Use Kryo serialization and register the given set of Avro schemas so that the generic record serializer can decrease network IO

  69. def registerKryoClasses(classes: Array[Class[_]]): SparkConf

    Use Kryo serialization and register the given set of classes with Kryo.

    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.

  70. def remove(key: String): SparkConf

    Remove a parameter from the configuration

  71. def set(key: String, value: String): SparkConf

    Set a configuration variable.

  72. def setAll(settings: Iterable[(String, String)]): SparkConf

    Set multiple parameters together

  73. def setAppName(name: String): SparkConf

    Set a name for your application.

    Set a name for your application. Shown in the Spark web UI.

  74. def setExecutorEnv(variables: Array[(String, String)]): SparkConf

    Set multiple environment variables to be used when launching executors.

    Set multiple environment variables to be used when launching executors. (Java-friendly version.)

  75. def setExecutorEnv(variables: Seq[(String, String)]): SparkConf

    Set multiple environment variables to be used when launching executors.

    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.

  76. def setExecutorEnv(variable: String, value: String): SparkConf

    Set an environment variable to be used when launching executors for this application.

    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.

  77. def setIfMissing(key: String, value: String): SparkConf

    Set a parameter if it isn't already configured

  78. def setJars(jars: Array[String]): SparkConf

    Set JAR files to distribute to the cluster.

    Set JAR files to distribute to the cluster. (Java-friendly version.)

  79. def setJars(jars: Seq[String]): SparkConf

    Set JAR files to distribute to the cluster.

  80. def setMaster(master: String): SparkConf

    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.

  81. def setSparkHome(home: String): SparkConf

    Set the location where Spark is installed on worker nodes.

  82. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  83. def toDebugString: String

    Return a string listing all keys and values, one per line.

    Return a string listing all keys and values, one per line. This is useful to print the configuration out for debugging.

  84. def toString(): String
    Definition Classes
    AnyRef → Any
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. def withLogContext(context: Map[String, String])(body: => Unit): Unit
    Attributes
    protected
    Definition Classes
    Logging

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Logging

Inherited from Cloneable

Inherited from ReadOnlySparkConf

Inherited from AnyRef

Inherited from Any

Ungrouped