HERE Data SDK - Scala API references < Back

Packages

package root

Definition Classes
root
package com

Definition Classes
root
package here

Definition Classes
com
package platform

Definition Classes
here
package data

Definition Classes
platform
package processing
This package provides the Data Processing Library for building distributed data processing applications.
This package provides the Data Processing Library for building distributed data processing applications.
A Runner both implements the interface with the environment for an application to run, and starts the application. The application, in turn, is driven by a Driver, that controls and performs the distributed processing.
Choose a Runner best suited for the environment where the application runs.
The Driver performs one of more tasks which read layers from input catalogs and write to one or more layers of an output catalog.
The main entry point in the processing library is the com.here.platform.data.processing.driver.DriverBuilder class where you can add different kinds of tasks to the driver. The driver runs the tasks, and commits the final results to the output catalog.
Tasks are implemented using one or more compilers.
The simplest compiler is the direct compiler which maps each input tile to N output tiles. The application needs to define com.here.platform.data.processing.compiler.Direct1ToNCompiler.
Other more complex compilation patterns are based on some kind of dependency tracking between input partitions and output partitions.
The processing Library supports the following patterns:
- com.here.platform.data.processing.compiler.NonIncrementalCompiler: non-incremental compilation only - com.here.platform.data.processing.compiler.DepCompiler: non-incremental dependency calculation and incremental compilation - com.here.platform.data.processing.compiler.IncrementalDepCompiler: incremental dependency calculation and compilation - com.here.platform.data.processing.compiler.Direct1ToNCompiler: incremental compilation where every output tile depends only on one input tile, and this mapping is independent from tile content - com.here.platform.data.processing.compiler.DirectMToNCompiler: incremental compilation where every output tile depends on multiple input tiles, and this mapping is independent from tile content - com.here.platform.data.processing.compiler.MapGroupCompiler: incremental compilation where every output tile can depend on multiple input tiles, and this mapping depend on the tile content - com.here.platform.data.processing.compiler.RefTreeCompiler: fully-managed two phases incremental compilation that can resolve references between input partitions. Input/Output dependency management is implemented and the developer doesn't need to provide this logic
The application's main object normally mixes in the a runner trait (like PipelineRunner) to setup the Driver, and interfaces with the environment where the application is run. See the Main classes in the example compilers for more details.
com.here.platform.data.processing.catalog, com.here.platform.data.processing.blobstore, and com.here.platform.data.processing.publisher contain utilities for accessing catalogs and payloads in a Spark-friendly way, providing an RDD-based abstraction over data and metadata. These classes are used by the processing library, but can also be used independently.

Definition Classes
data
package driver

Definition Classes
processing
package config
This package contains the configuration classes for all components of a Driver.
This package contains the configuration classes for all components of a Driver. Configuration is read from application.conf and provided to the developer as a com.here.platform.data.processing.driver.config.CompleteConfig instance, when the driver is setup.

Definition Classes
driver
CatalogConfig
CatalogsConfig
CompileInConfig
CompileOutConfig
CompleteConfig
DriverConfig
ExecutorConfig
ExecutorDebugConfig
PartitionKeyFilterConfig
RefTreeExecutorConfig
SparkStorageLevelsConfig
StateConfig

com.here.platform.data.processing.driver.config

DriverConfig

case class DriverConfig(appName: String, parallelUploads: Int, parallelRetrievers: Int, numCommitPartitions: Int, sparkStorageLevels: SparkStorageLevelsConfig, state: StateConfig, disableIncremental: Boolean, uniquePartitionLimitInBytes: Int, disableCommitIntegrityCheck: Boolean, allowEmptyPayloads: Boolean, catalogs: CatalogsConfig) extends Product with Serializable

The configuration necessary to instantiate and configure a com.here.platform.data.processing.driver.Driver.

appName: The name of the application to be set in the Spark context.
parallelUploads: The number of parallel uploads the library should perform inside a Spark task, when data is published to the Blob API.
parallelRetrievers: The number of parallel retrieves the library should perform inside a Spark task, when data is retrieved from the Blob API.
numCommitPartitions: The maximum number of parts to commit within a multipart commit to the Data API.
sparkStorageLevels: The configuration of the Spark storage levels for each RDD category in the library.
state: The configuration for the state layer that specifies how the layer is stored.
disableIncremental: If true, incremental compilation is disabled.
uniquePartitionLimitInBytes: The size limit beyond which partitions are considered to be unique. The data handle for partitions with identical content is reused to avoid uploading the same payload multiple times.
disableCommitIntegrityCheck: If true, the final integrity check on the committed partitions is disabled.
allowEmptyPayloads: Whether to allow publishing of empty (0 byte) payloads.
catalogs: catalog specific driver configurations.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

DriverConfig
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new DriverConfig(appName: String, parallelUploads: Int, parallelRetrievers: Int, numCommitPartitions: Int, sparkStorageLevels: SparkStorageLevelsConfig, state: StateConfig, disableIncremental: Boolean, uniquePartitionLimitInBytes: Int, disableCommitIntegrityCheck: Boolean, allowEmptyPayloads: Boolean, catalogs: CatalogsConfig)
appName
The name of the application to be set in the Spark context.
parallelUploads
The number of parallel uploads the library should perform inside a Spark task, when data is published to the Blob API.
parallelRetrievers
The number of parallel retrieves the library should perform inside a Spark task, when data is retrieved from the Blob API.
numCommitPartitions
The maximum number of parts to commit within a multipart commit to the Data API.
sparkStorageLevels
The configuration of the Spark storage levels for each RDD category in the library.
state
The configuration for the state layer that specifies how the layer is stored.
disableIncremental
If true, incremental compilation is disabled.
uniquePartitionLimitInBytes
The size limit beyond which partitions are considered to be unique. The data handle for partitions with identical content is reused to avoid uploading the same payload multiple times.
disableCommitIntegrityCheck
If true, the final integrity check on the committed partitions is disabled.
allowEmptyPayloads
Whether to allow publishing of empty (0 byte) payloads.
catalogs
catalog specific driver configurations.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowEmptyPayloads: Boolean
val appName: String
final def asInstanceOf[T0]: T0

Definition Classes
Any
val catalogs: CatalogsConfig
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
val disableCommitIntegrityCheck: Boolean
val disableIncremental: Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val numCommitPartitions: Int
val parallelRetrievers: Int
val parallelUploads: Int
val sparkStorageLevels: SparkStorageLevelsConfig
val state: StateConfig
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val uniquePartitionLimitInBytes: Int
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

Packages

DriverConfig

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

DriverConfig 

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

DriverConfig