Class ExecutorResourceRequest

All Implemented Interfaces:
Serializable, scala.Serializable

public class ExecutorResourceRequest extends Object implements scala.Serializable
An Executor resource request. This is used in conjunction with the ResourceProfile to programmatically specify the resources needed for an RDD that will be applied at the stage level.

This is used to specify what the resource requirements are for an Executor and how Spark can find out specific details about those resources. Not all the parameters are required for every resource type. Resources like GPUs are supported and have same limitations as using the global spark configs spark.executor.resource.gpu.*. The amount, discoveryScript, and vendor parameters for resources are all the same parameters a user would specify through the configs: spark.executor.resource.{resourceName}.{amount, discoveryScript, vendor}.

For instance, a user wants to allocate an Executor with GPU resources on YARN. The user has to specify the resource name (gpu), the amount or number of GPUs per Executor, the discovery script would be specified so that when the Executor starts up it can discovery what GPU addresses are available for it to use because YARN doesn't tell Spark that, then vendor would not be used because its specific for Kubernetes.

See the configuration and cluster specific docs for more details.

Use ExecutorResourceRequests class as a convenience API.

param: resourceName Name of the resource param: amount Amount requesting param: discoveryScript Optional script used to discover the resources. This is required on some cluster managers that don't tell Spark the addresses of the resources allocated. The script runs on Executors startup to discover the addresses of the resources available. param: vendor Optional vendor, required for some cluster managers

See Also:
  • Constructor Details

    • ExecutorResourceRequest

      public ExecutorResourceRequest(String resourceName, long amount, String discoveryScript, String vendor)
  • Method Details

    • resourceName

      public String resourceName()
    • amount

      public long amount()
    • discoveryScript

      public String discoveryScript()
    • vendor

      public String vendor()
    • equals

      public boolean equals(Object obj)
      equals in class Object
    • hashCode

      public int hashCode()
      hashCode in class Object
    • toString

      public String toString()
      toString in class Object