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

com.here.platform.data

client

package client

Package Members

package annotation
package base
package blobstore
package common
package context
package converters
package engine
package external
package flink
package hdfs
package http
package impl
package json
package local
package model
Contains the base traits, classes, and objects needed to use in Data Client.
package scaladsl
package service
package settings
package spark
package utils
package v2

Type Members

final case class BatchPublicationFailedException(message: String) extends DataClientNonRetriableException with Product with Serializable
A batch publication failed to complete.
final case class ConflictException(message: String, dataHandle: String, storedSize: Option[Long], storedCompressionSize: Option[Long]) extends DataClientRetriableException with Product with Serializable
A blob storage write conflict.
sealed class DataClientException extends RuntimeException
The base class of exceptions returned through the Data Client API.
sealed class DataClientNonRetriableException extends DataClientException with NonRetriableException
The base class of non-retriable exceptions returned through the Data Client API.
sealed class DataClientRetriableException extends DataClientException
The base class of retriable exceptions returned through the Data Client API.
final case class HttpStatusException(statusCode: Int, message: String) extends Exception with Product with Serializable
An underlying HTTP service API response exception.
An underlying HTTP service API response exception.
This is usually wrapped inside a DataClientException.
final case class NotFoundException(message: String, cause: Option[Throwable] = None) extends DataClientNonRetriableException with Product with Serializable
Exception returned when a resource is not found in Data Service.
Exception returned when a resource is not found in Data Service.
When APIs are not wrapping their result in scala.Option, this exception will be thrown for 404 errors returned by Data Service.b
final case class StreamSubscriptionShutDownException(message: String) extends DataClientNonRetriableException with Product with Serializable
Error happening while shutting down a stream subscription.

Packages

client

package client

Package Members

Type Members

Ungrouped

client