Package

eu.shiftforward.adstax.ups

api

Permalink

package api

Visibility
  1. Public
  2. All

Type Members

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

    Permalink

    An array attribute value.

    An array attribute value.

    arr

    the array of attribute values

  2. sealed trait AttributeMergingStrategy extends AnyRef

    Permalink

    A strategy to merge two sets of user attributes.

  3. sealed trait AttributeValue extends AnyRef

    Permalink

    The value of an attribute.

    The value of an attribute. An attribute takes one of a fixed set of attribute types.

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

    Permalink

    A boolean attribute value.

    A boolean attribute value.

    value

    the boolean value

  5. case class DeleteUser(userId: String, clientId: String) extends UserProfileStorageRequest with Product with Serializable

    Permalink

    A request to delete the information about a user.

    A request to delete the information about a user.

    userId

    the identifier of the user

    clientId

    the identifier of the client

  6. case class DeleteUserResponse(success: Boolean) extends UserProfileStorageResponse with Product with Serializable

    Permalink

    The response for a DeleteUser request.

    The response for a DeleteUser request.

    success

    true of the operation was successful, false otherwise

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

    Permalink

    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

  8. case class GetUser(userId: String, clientId: String) extends UserProfileStorageRequest with Product with Serializable

    Permalink

    A request to retrieve information about a user.

    A request to retrieve information about a user.

    userId

    the identifier of the user

    clientId

    the identifier of the client

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

    Permalink

    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

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

    Permalink

    A map attribute value.

    A map attribute value.

    map

    the map of keys to attribute values

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

    Permalink

    A numeric attribute value.

    A numeric attribute value.

    value

    the number value

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

    Permalink

    A string attribute value.

    A string attribute value.

    value

    the string value

  13. case class UpdateUser(userId: String, clientId: String, attributes: UserAttributes, mergeStrategy: AttributeMergingStrategy) extends UserProfileStorageRequest with Product with Serializable

    Permalink

    A request to update the information about a user.

    A request to update the information about a user.

    userId

    the identifier of the user

    clientId

    the identifier of the client

    attributes

    the attributes to update the user with

    mergeStrategy

    the strategy to use when merging the attributes

  14. case class UpdateUserResponse(success: Boolean) extends UserProfileStorageResponse with Product with Serializable

    Permalink

    The response for an UpdateUser request.

    The response for an UpdateUser request.

    success

    true of the operation was successful, false otherwise

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

    Permalink

    The attribute set of a user.

    The attribute set of a user.

    attributes

    the map from attribute names to values

  16. trait UserProfileStorageClient extends AnyRef

    Permalink

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

  17. sealed trait UserProfileStorageRequest extends AnyRef

    Permalink

    A request to be sent to the User Profile Storage module.

  18. sealed trait UserProfileStorageResponse extends AnyRef

    Permalink

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

Value Members

  1. object AttributeMergingStrategy

    Permalink
  2. object AttributeValue

    Permalink
  3. object DeleteUser extends Serializable

    Permalink
  4. object DeleteUserResponse extends Serializable

    Permalink
  5. object GetUser extends Serializable

    Permalink
  6. object GetUserResponse extends Serializable

    Permalink
  7. object JoinMergingStrategy extends AttributeMergingStrategy with Product with Serializable

    Permalink

    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)]

  8. object ReplaceMergingStrategy extends AttributeMergingStrategy with Product with Serializable

    Permalink

    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)]

  9. object UpdateUser extends Serializable

    Permalink
  10. object UpdateUserResponse extends Serializable

    Permalink
  11. object UserAttributes extends Serializable

    Permalink
  12. package rpc

    Permalink

Ungrouped