storage

Type Members

1. case class AccessKey(key: String, appid: Int, events: Seq[String]) extends Product with Serializable

   :: DeveloperApi :: Stores mapping of access keys, app IDs, and lists of allowed event names

2. trait AccessKeys extends AnyRef

   :: DeveloperApi :: Base trait of the AccessKey data access object

3. case class App(id: Int, name: String, description: Option[String]) extends Product with Serializable

   :: DeveloperApi :: Stores mapping of app IDs and names

4. trait Apps extends AnyRef

   :: DeveloperApi :: Base trait of the App data access object

5. trait BaseStorageClient extends AnyRef

   :: DeveloperApi :: Any storage backend drivers will need to implement this trait with exactly StorageClient as the class name.

6. class BiMap[K, V] extends Serializable

   Immutable Bi-directional Map

7. case class Channel(id: Int, name: String, appid: Int) extends Product with Serializable

   :: DeveloperApi :: Stores mapping of channel IDs, names and app ID

8. trait Channels extends AnyRef

   :: DeveloperApi :: Base trait of the Channel data access object

9. class DataMap extends Serializable

   A DataMap stores properties of the event or entity.

10. case class DataMapException(msg: String, cause: Exception) extends Exception with Product with Serializable

    Exception class for DataMap

11. case class EngineInstance(id: String, status: String, startTime: com.github.nscala_time.time.Imports.DateTime, endTime: com.github.nscala_time.time.Imports.DateTime, engineId: String, engineVersion: String, engineVariant: String, engineFactory: String, batch: String, env: Map[String, String], sparkConf: Map[String, String], dataSourceParams: String, preparatorParams: String, algorithmsParams: String, servingParams: String) extends Product with Serializable

    :: DeveloperApi :: Stores parameters, model, and other information for each engine instance

12. class EngineInstanceSerializer extends CustomSerializer[EngineInstance]

    :: DeveloperApi :: JSON4S serializer for EngineInstance

13. trait EngineInstances extends AnyRef

    :: DeveloperApi :: Base trait of the EngineInstance data access object

14. case class EngineManifest(id: String, version: String, name: String, description: Option[String], files: Seq[String], engineFactory: String) extends Product with Serializable

    :: DeveloperApi :: Provides a way to discover engines by ID and version in a distributed environment

15. class EngineManifestSerializer extends CustomSerializer[EngineManifest]

    :: DeveloperApi :: JSON4S serializer for EngineManifest

16. trait EngineManifests extends AnyRef

    :: DeveloperApi :: Base trait of the EngineManifest data access object

17. class EntityIdIxMap extends Serializable

    :: Experimental ::

18. class EntityMap[A] extends EntityIdIxMap

    :: Experimental ::

19. case class EvaluationInstance(id: String = "", status: String = "", startTime: com.github.nscala_time.time.Imports.DateTime = ..., endTime: com.github.nscala_time.time.Imports.DateTime = ..., evaluationClass: String = "", engineParamsGeneratorClass: String = "", batch: String = "", env: Map[String, String] = ..., sparkConf: Map[String, String] = ..., evaluatorResults: String = "", evaluatorResultsHTML: String = "", evaluatorResultsJSON: String = "") extends Product with Serializable

    :: DeveloperApi :: Stores meta information for each evaluation instance.

20. class EvaluationInstanceSerializer extends CustomSerializer[EvaluationInstance]

    :: DeveloperApi :: JSON4S serializer for EvaluationInstance

21. trait EvaluationInstances extends AnyRef

    :: DeveloperApi :: Base trait of the EvaluationInstance data access object

22. case class Event(eventId: Option[String] = scala.None, event: String, entityType: String, entityId: String, targetEntityType: Option[String] = scala.None, targetEntityId: Option[String] = scala.None, properties: DataMap = DataMap.apply(), eventTime: DateTime = org.joda.time.DateTime.now(), tags: Seq[String] = immutable.this.Nil, prId: Option[String] = scala.None, creationTime: DateTime = org.joda.time.DateTime.now()) extends Product with Serializable

    Each event in the Event Store can be represented by fields in this case class.

23. trait LEvents extends AnyRef

    :: DeveloperApi :: Base trait of a data access object that directly returns Event without going through Spark's parallelization.

24. case class Model(id: String, models: Array[Byte]) extends Product with Serializable

    :: DeveloperApi :: Stores model for each engine instance

25. class ModelSerializer extends CustomSerializer[Model]

    :: DeveloperApi :: JSON4S serializer for Model

26. trait Models extends AnyRef

    :: DeveloperApi :: Base trait for of the Model data access object

27. trait PEvents extends Serializable

    :: DeveloperApi :: Base trait of a data access object that returns Event related RDD data structure.

28. class PropertyMap extends DataMap

    A PropertyMap stores aggregated properties of the entity.

29. case class StorageClientConfig(parallel: Boolean = false, test: Boolean = false, properties: Map[String, String] = ...) extends Product with Serializable

    :: DeveloperApi :: A wrapper of storage client configuration that will be populated by PredictionIO automatically, and passed to the StorageClient during instantiation.

30. class StorageClientException extends RuntimeException

    :: DeveloperApi :: Thrown when a StorageClient runs into an exceptional condition

31. class StorageException extends Exception

    :: DeveloperApi :: Thrown by data access objects when they run into exceptional conditions