api

Type Members

case class ArrayAttrValue(arr: Seq[AttributeValue]) extends AttributeValue with Product with Serializable

An array attribute value.
An array attribute value.
arr
the array of attribute values
sealed trait AttributeMergingStrategy extends AnyRef

A strategy to merge two sets of user attributes.
sealed trait AttributeValue extends AnyRef

The value of an attribute.
The value of an attribute. An attribute takes one of a fixed set of attribute types.
case class BooleanAttrValue(value: Boolean) extends AttributeValue with Product with Serializable

A boolean attribute value.
A boolean attribute value.
value
the boolean value
case class DeleteUser(userId: UserId) extends UserProfileStorageRequest with Product with Serializable

A request to delete the information about a user.
A request to delete the information about a user.
userId
the identifier of the user
case class DeleteUserAttribute(userId: UserId, attributeName: String) extends UserProfileStorageRequest with Product with Serializable

A request to delete an attribute of a user.
A request to delete an attribute of a user.
userId
the identifier of the user
attributeName
the name of the attribute
case class GeoAttrValue(lat: Double, lon: Double) extends AttributeValue with Product with Serializable

An attribute value representing a set of lan-lon coordinates.
An attribute value representing a set of lan-lon coordinates.
lat
the latitude value
lon
the longitude value
case class GetUser(userId: UserId) extends UserProfileStorageRequest with Product with Serializable

A request to retrieve information about a user.
A request to retrieve information about a user.
userId
the identifier of the user
case class GetUserAttribute(userId: UserId, attributeName: String) extends UserProfileStorageRequest with Product with Serializable

A request to retrieve a single attribute of a user.
A request to retrieve a single attribute of a user.
userId
the identifier of the user
attributeName
the name of the attribute
case class GetUserAttributeResponse(attributeValue: Option[AttributeValue]) extends UserProfileStorageResponse with Product with Serializable

The response for a GetUserAttribute request.
The response for a GetUserAttribute request.
attributeValue
the attribute value for the requested key wrapped in a Some if the user and the attribute exists, None otherwise
case class GetUserResponse(attributes: Option[UserAttributes]) extends UserProfileStorageResponse with Product with Serializable

The response for a GetUser request.
The response for a GetUser request.
attributes
the attributes associated with the user wrapped in a Some if the user exists, None otherwise
case class MapAttrValue(map: Map[String, AttributeValue]) extends AttributeValue with Product with Serializable

A map attribute value.
A map attribute value.
map
the map of keys to attribute values
case class MergeUsers(userId1: UserId, userId2: UserId) extends UserProfileStorageRequest with Product with Serializable

A request to merge the information about two users.
A request to merge the information about two users.
userId1
the identifier of the first user
userId2
the identifier of the second user
case class NumericAttrValue(value: Double) extends AttributeValue with Product with Serializable

A numeric attribute value.
A numeric attribute value.
value
the number value
case class StringAttrValue(value: String) extends AttributeValue with Product with Serializable

A string attribute value.
A string attribute value.
value
the string value
case class UpdateUser(userId: UserId, attributes: UserAttributes, mergeStrategy: AttributeMergingStrategy) extends UserProfileStorageRequest with Product with Serializable

A request to update the information about a user.
A request to update the information about a user.
userId
the identifier of the user
attributes
the attributes to update the user with
mergeStrategy
the strategy to use when merging the attributes
case class UserAttributes(attributes: Map[String, AttributeValue]) extends Product with Serializable

The attribute set of a user.
The attribute set of a user.
attributes
the map from attribute names to values
case class UserId(idType: String, id: String) extends Product with Serializable

A fully qualified user identifier.
A fully qualified user identifier.
idType
the type of identifier
id
the identifier
trait UserProfileStorageClient extends AnyRef

Interface for clients capable of interacting with the User Profile Storage module by retrieving, updating or deleting information about users.
sealed trait UserProfileStorageRequest extends AnyRef

A request to be sent to the User Profile Storage module.
sealed trait UserProfileStorageResponse extends AnyRef

A response from the User Profile Storage module to a UserProfileStorageRequest.

Value Members

object AttributeMergingStrategy
object AttributeValue
object DeleteUser extends Serializable
object DeleteUserAttribute extends Serializable
object DeleteUserAttributeResponse extends UserProfileStorageResponse with Product with Serializable

The response for a DeleteUserAttribute request.
object DeleteUserResponse extends UserProfileStorageResponse with Product with Serializable

The response for a DeleteUser request.
object GetUser extends Serializable
object GetUserAttribute extends Serializable
object GetUserAttributeResponse extends Serializable
object GetUserResponse extends Serializable
object JoinMergingStrategy extends AttributeMergingStrategy with Product with Serializable

Simple attribute merge strategy that updates the old attributes with the most recent ones.
Simple attribute merge strategy that updates the old attributes with the most recent ones. Attributes that were only present in the old attributes are preserved.
Example: [(a, 1), (b, 1)] * [(a, 3), (c, 1)] = [(a, 3), (b, 1), (c, 1)]
object MergeUsers extends Serializable
object MergeUsersResponse extends UserProfileStorageResponse with Product with Serializable

The response for a MergeUsers request.
object ReplaceMergingStrategy extends AttributeMergingStrategy with Product with Serializable

Simple attribute merge strategy that overwrites the old attributes with new attributes, removing all old attributes.
Simple attribute merge strategy that overwrites the old attributes with new attributes, removing all old attributes.
Example: [(a, 1), (b, 1)] * [(a, 3), (c, 1)] = [(a, 3), (c, 1)]
object UpdateUser extends Serializable
object UpdateUserResponse extends UserProfileStorageResponse with Product with Serializable

The response for an UpdateUser request.
object UserAttributes extends Serializable
object UserId extends Serializable
package rpc

package api

Type Members

case class ArrayAttrValue(arr: Seq[AttributeValue]) extends AttributeValue with Product with Serializable

sealed trait AttributeMergingStrategy extends AnyRef

sealed trait AttributeValue extends AnyRef

case class BooleanAttrValue(value: Boolean) extends AttributeValue with Product with Serializable

case class DeleteUser(userId: UserId) extends UserProfileStorageRequest with Product with Serializable

case class DeleteUserAttribute(userId: UserId, attributeName: String) extends UserProfileStorageRequest with Product with Serializable

case class GeoAttrValue(lat: Double, lon: Double) extends AttributeValue with Product with Serializable

case class GetUser(userId: UserId) extends UserProfileStorageRequest with Product with Serializable

case class GetUserAttribute(userId: UserId, attributeName: String) extends UserProfileStorageRequest with Product with Serializable

case class GetUserAttributeResponse(attributeValue: Option[AttributeValue]) extends UserProfileStorageResponse with Product with Serializable

case class GetUserResponse(attributes: Option[UserAttributes]) extends UserProfileStorageResponse with Product with Serializable

case class MapAttrValue(map: Map[String, AttributeValue]) extends AttributeValue with Product with Serializable

case class MergeUsers(userId1: UserId, userId2: UserId) extends UserProfileStorageRequest with Product with Serializable

case class NumericAttrValue(value: Double) extends AttributeValue with Product with Serializable

case class StringAttrValue(value: String) extends AttributeValue with Product with Serializable

case class UpdateUser(userId: UserId, attributes: UserAttributes, mergeStrategy: AttributeMergingStrategy) extends UserProfileStorageRequest with Product with Serializable

case class UserAttributes(attributes: Map[String, AttributeValue]) extends Product with Serializable

case class UserId(idType: String, id: String) extends Product with Serializable

trait UserProfileStorageClient extends AnyRef

sealed trait UserProfileStorageRequest extends AnyRef

sealed trait UserProfileStorageResponse extends AnyRef

Value Members

object AttributeMergingStrategy

object AttributeValue

object DeleteUser extends Serializable

object DeleteUserAttribute extends Serializable

object DeleteUserAttributeResponse extends UserProfileStorageResponse with Product with Serializable

object DeleteUserResponse extends UserProfileStorageResponse with Product with Serializable

object GetUser extends Serializable

object GetUserAttribute extends Serializable

object GetUserAttributeResponse extends Serializable

object GetUserResponse extends Serializable

object JoinMergingStrategy extends AttributeMergingStrategy with Product with Serializable

object MergeUsers extends Serializable

object MergeUsersResponse extends UserProfileStorageResponse with Product with Serializable

object ReplaceMergingStrategy extends AttributeMergingStrategy with Product with Serializable

object UpdateUser extends Serializable

object UpdateUserResponse extends UserProfileStorageResponse with Product with Serializable

object UserAttributes extends Serializable

object UserId extends Serializable

package rpc

Ungrouped