org.apache.predictionio.data.storage.hbase

HBLEvents

class HBLEvents extends LEvents with Logging

Linear Supertypes
Logging, LEvents, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HBLEvents
  2. Logging
  3. LEvents
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HBLEvents(client: HBClient, config: StorageClientConfig, namespace: String)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val client: HBClient

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def close(): Unit

    :: DeveloperApi :: Close this Event Store interface object, e.

    :: DeveloperApi :: Close this Event Store interface object, e.g. close connection, release resources, etc.

    Definition Classes
    HBLEventsLEvents
  10. def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  11. def debug(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  12. val defaultTimeout: FiniteDuration

    Default timeout for asynchronous operations that is set to 1 minute

    Default timeout for asynchronous operations that is set to 1 minute

    Definition Classes
    LEvents
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  16. def error(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def futureDelete(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Boolean]

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    channelId

    Optional channel ID that contains the Event

    Definition Classes
    HBLEventsLEvents
  19. def futureDelete(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Boolean]

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    Definition Classes
    LEvents
    Annotations
    @DeveloperApi()
  20. def futureFind(appId: Int, channelId: Option[Int] = None, startTime: Option[DateTime] = None, untilTime: Option[DateTime] = None, entityType: Option[String] = None, entityId: Option[String] = None, eventNames: Option[Seq[String]] = None, targetEntityType: Option[Option[String]] = None, targetEntityId: Option[Option[String]] = None, limit: Option[Int] = None, reversed: Option[Boolean] = None)(implicit ec: ExecutionContext): Future[Iterator[Event]]

    :: DeveloperApi :: Reads from database and returns a Future of Iterator of Events.

    :: DeveloperApi :: Reads from database and returns a Future of Iterator of Events.

    appId

    return events of this app ID

    channelId

    return events of this channel ID (default channel if it's None)

    startTime

    return events with eventTime >= startTime

    untilTime

    return events with eventTime < untilTime

    entityType

    return events of this entityType

    entityId

    return events of this entityId

    eventNames

    return events with any of these event names.

    targetEntityType

    return events of this targetEntityType:

    • None means no restriction on targetEntityType
    • Some(None) means no targetEntityType for this event
    • Some(Some(x)) means targetEntityType should match x.
    targetEntityId

    return events of this targetEntityId

    • None means no restriction on targetEntityId
    • Some(None) means no targetEntityId for this event
    • Some(Some(x)) means targetEntityId should match x.
    limit

    Limit number of events. Get all events if None or Some(-1)

    reversed

    Reverse the order.

    • return oldest events first if None or Some(false) (default)
    • return latest events first if Some(true)
    ec

    ExecutionContext

    returns

    Future[Iterator[Event]]

    Definition Classes
    HBLEventsLEvents
  21. def futureGet(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Option[Event]]

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    channelId

    Optional channel ID that contains the Event

    Definition Classes
    HBLEventsLEvents
  22. def futureGet(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Option[Event]]

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    Definition Classes
    LEvents
    Annotations
    @DeveloperApi()
  23. def futureInsert(event: Event, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[String]

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    event

    An Event to be inserted

    appId

    App ID for the Event to be inserted to

    channelId

    Optional channel ID for the Event to be inserted to

    Definition Classes
    HBLEventsLEvents
  24. def futureInsert(event: Event, appId: Int)(implicit ec: ExecutionContext): Future[String]

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    event

    An Event to be inserted

    appId

    App ID for the Event to be inserted to

    Definition Classes
    LEvents
    Annotations
    @DeveloperApi()
  25. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  26. def getTable(appId: Int, channelId: Option[Int] = None): HTableInterface

  27. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  28. def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  29. def info(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  30. def init(appId: Int, channelId: Option[Int] = None): Boolean

    :: DeveloperApi :: Initialize Event Store for an app ID and optionally a channel ID.

    :: DeveloperApi :: Initialize Event Store for an app ID and optionally a channel ID. This routine is to be called when an app is first created.

    appId

    App ID

    channelId

    Optional channel ID

    returns

    true if initialization was successful; false otherwise.

    Definition Classes
    HBLEventsLEvents
  31. def isDebugEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  32. def isErrorEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  33. def isInfoEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  34. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  35. def isTraceEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  36. def isWarnEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  37. def logger: Logger

    Attributes
    protected
    Definition Classes
    Logging
  38. def loggerName: String

    Attributes
    protected
    Definition Classes
    Logging
  39. val namespace: String

  40. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  41. final def notify(): Unit

    Definition Classes
    AnyRef
  42. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  43. def remove(appId: Int, channelId: Option[Int] = None): Boolean

    :: DeveloperApi :: Remove Event Store for an app ID and optional channel ID.

    :: DeveloperApi :: Remove Event Store for an app ID and optional channel ID.

    appId

    App ID

    channelId

    Optional channel ID

    returns

    true if removal was successful; false otherwise.

    Definition Classes
    HBLEventsLEvents
  44. def resultToEvent(result: Result, appId: Int): Event

  45. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  46. def toString(): String

    Definition Classes
    AnyRef → Any
  47. def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  48. def trace(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  49. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  53. def warn(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging

Deprecated Value Members

  1. def findSingleEntity(appId: Int, channelId: Option[Int] = None, entityType: String, entityId: String, eventNames: Option[Seq[String]] = None, targetEntityType: Option[Option[String]] = None, targetEntityId: Option[Option[String]] = None, startTime: Option[DateTime] = None, untilTime: Option[DateTime] = None, limit: Option[Int] = None, latest: Boolean = true, timeout: Duration = defaultTimeout)(implicit ec: ExecutionContext): Either[StorageError, Iterator[Event]]

    reads events of the specified entity.

    reads events of the specified entity.

    appId

    return events of this app ID

    channelId

    return events of this channel ID (default channel if it's None)

    entityType

    return events of this entityType

    entityId

    return events of this entityId

    eventNames

    return events with any of these event names.

    targetEntityType

    return events of this targetEntityType:

    • None means no restriction on targetEntityType
    • Some(None) means no targetEntityType for this event
    • Some(Some(x)) means targetEntityType should match x.
    targetEntityId

    return events of this targetEntityId

    • None means no restriction on targetEntityId
    • Some(None) means no targetEntityId for this event
    • Some(Some(x)) means targetEntityId should match x.
    startTime

    return events with eventTime >= startTime

    untilTime

    return events with eventTime < untilTime

    limit

    Limit number of events. Get all events if None or Some(-1)

    latest

    Return latest event first (default true)

    ec

    ExecutionContext

    returns

    Either[StorageError, Iterator[Event]]

    Definition Classes
    LEvents
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.2) Use LEventStore.findByEntity() instead.

Inherited from Logging

Inherited from LEvents

Inherited from AnyRef

Inherited from Any

Ungrouped