User (anoa-tests 3.1.2 API)

All Superinterfaces:

Comparable<User<?>>, Serializable, Supplier<T>

All Known Implementing Classes:

User.Avro, User.NativeImpl, User.Protobuf, User.Thrift
```
public interface User<T>
extends Supplier<T>, Comparable<User<?>>, Serializable
```
3.3.12 User Object The “user” object contains information known or derived about the human user of the device. Note that the user ID is an exchange artifact (refer to the “device” object for hardware or platform derived IDs) and may be subject to rotation policies. However, this user ID must be stable long enough to serve reasonably as the basis for frequency capping. The user object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown. If device ID is used as a proxy for unique user ID, use the device object.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`User.Avro`
`static class`	`User.AvroBuilder`
`static interface`	`User.Builder<T>`
`static class`	`User.Comparator`
`static class`	`User.NativeImpl`
`static class`	`User.Protobuf`
`static class`	`User.ProtobufBuilder`
`static class`	`User.Thrift`
`static class`	`User.ThriftBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static User.Avro`	`avro(User<?> instance)` Returns a wrapped Avro record based on an instance of User.
`static User.Avro`	`avro(UserAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(User<?> other)`
`T`	`get()` Returns underlying object.
`static Class<UserAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`String`	`getBuyeruid()` Buyer’s user ID for this user as mapped by exchange for the buyer.
`static Comparator<User<?>>`	`getComparator()` Returns comparator instance for User objects.
`String`	`getCustomdata()` If supported by the exchange, this is custom data that the bidder had stored in the exchange’s cookie.
`List<Data<?>>`	`getData()` See Data Object.
`String`	`getGender()` Gender as “M” male, “F” female, “O” Other.
`Geo<?>`	`getGeo()` Home geo for the user (e.g., based off of registration data); this is different from the current location of the access device (that is defined by the geo object embedded in the Device Object); see Geo Object.
`String`	`getId()` Unique consumer ID of this user on the exchange.
`String`	`getKeywords()` Comma separated list of keywords of consumer interests or intent.
`static Class<OpenRtbProtobuf.User>`	`getProtobufClass()` Returns Protobuf class for this struct.
`static com.google.protobuf.Descriptors.Descriptor`	`getProtobufDescriptor()` Returns Protobuf descriptor for this struct.
`static Class<AdExchangeProtobuf>`	`getProtobufProtocolClass()` Returns Protobuf protocol class for this struct.
`static com.google.protobuf.Descriptors.FileDescriptor`	`getProtobufProtocolDescriptor()` Returns Protobuf protocol descriptor for this struct.
`static Class<UserThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<UserThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`int`	`getYob()` Year of birth as a 4-digit integer.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultBuyeruid()`
`boolean`	`isDefaultCustomdata()`
`boolean`	`isDefaultData()`
`boolean`	`isDefaultGender()`
`boolean`	`isDefaultGeo()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultKeywords()`
`boolean`	`isDefaultYob()`
`static User.NativeImpl`	`nativeImpl(User<?> instance)` Returns a POJO based on an instance of User.
`static User.Builder<UserAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static User.Builder<UserAvro>`	`newAvroBuilder(User<?> other)` Returns new Avro builder instance based on existing prototype User.
`static User.Builder<UserAvro>`	`newAvroBuilder(UserAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static User.Builder<UserAvro>`	`newAvroBuilder(UserAvro other)` Returns new Avro builder instance based on existing prototype.
`User.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static User.Builder<User.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static User.Builder<User.NativeImpl>`	`newNativeImplBuilder(User<?> other)` Returns a POJO builder instance based on existing prototype User.
`static User.Builder<OpenRtbProtobuf.User>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static User.Builder<OpenRtbProtobuf.User>`	`newProtobufBuilder(OpenRtbProtobuf.User other)` Returns new Protobuf builder instance based on existing prototype.
`static User.Builder<OpenRtbProtobuf.User>`	`newProtobufBuilder(User<?> other)` Returns new Protobuf builder instance based on existing prototype User.
`static User.Builder<UserThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static User.Builder<UserThrift>`	`newThriftBuilder(User<?> other)` Returns new Thrift builder instance based on existing prototype User.
`static User.Builder<UserThrift>`	`newThriftBuilder(UserThrift other)` Returns new Thrift builder instance based on existing prototype.
`static User.Protobuf`	`protobuf(OpenRtbProtobuf.User wrapped)` Wraps an existing Protobuf message.
`static User.Protobuf`	`protobuf(User<?> instance)` Returns a wrapped Protobuf message based on an instance of User.
`static User.Thrift`	`thrift(User<?> instance)` Returns a wrapped Thrift struct based on an instance of User.
`static User.Thrift`	`thrift(UserThrift instance)` Creates a new wrapped Thrift struct copied from an existing instance.

- Method Detail
  - isDefault
```
default boolean isDefault()
```
    True if all fields are set to default values.
  - get
```
T get()
```
    Returns underlying object.
    
    Specified by:
    
    get in interface Supplier<T>
  - newBuilder
```
User.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
String getId()
```
    Unique consumer ID of this user on the exchange.
  - isDefaultId
```
boolean isDefaultId()
```
  - getBuyeruid
```
String getBuyeruid()
```
    Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie)
  - isDefaultBuyeruid
```
boolean isDefaultBuyeruid()
```
  - getYob
```
int getYob()
```
    Year of birth as a 4-digit integer.
  - isDefaultYob
```
boolean isDefaultYob()
```
  - getGender
```
String getGender()
```
    Gender as “M” male, “F” female, “O” Other. (Null indicates unknown).
  - isDefaultGender
```
boolean isDefaultGender()
```
  - getKeywords
```
String getKeywords()
```
    Comma separated list of keywords of consumer interests or intent.
  - isDefaultKeywords
```
boolean isDefaultKeywords()
```
  - getCustomdata
```
String getCustomdata()
```
    If supported by the exchange, this is custom data that the bidder had stored in the exchange’s cookie. The string may be in base85 cookie safe characters, and be in any format. This may useful for storing user features. Note: Proper JSON encoding must be used to include “escaped” quotation marks.
  - isDefaultCustomdata
```
boolean isDefaultCustomdata()
```
  - getGeo
```
Geo<?> getGeo()
```
    Home geo for the user (e.g., based off of registration data); this is different from the current location of the access device (that is defined by the geo object embedded in the Device Object); see Geo Object.
  - isDefaultGeo
```
boolean isDefaultGeo()
```
  - getData
```
List<Data<?>> getData()
```
    See Data Object.
  - isDefaultData
```
boolean isDefaultData()
```
  - getComparator
```
static Comparator<User<?>> getComparator()
```
    Returns comparator instance for User objects.
  - compareTo
```
default int compareTo(User<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<User<?>>
  - newNativeImplBuilder
```
static User.Builder<User.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static User.Builder<User.NativeImpl> newNativeImplBuilder(User<?> other)
```
    Returns a POJO builder instance based on existing prototype User.
  - nativeImpl
```
static User.NativeImpl nativeImpl(User<?> instance)
```
    Returns a POJO based on an instance of User.
  - newAvroBuilder
```
static User.Builder<UserAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static User.Builder<UserAvro> newAvroBuilder(UserAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static User.Builder<UserAvro> newAvroBuilder(UserAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static User.Builder<UserAvro> newAvroBuilder(User<?> other)
```
    Returns new Avro builder instance based on existing prototype User.
  - avro
```
static User.Avro avro(User<?> instance)
```
    Returns a wrapped Avro record based on an instance of User.
  - avro
```
static User.Avro avro(UserAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<UserAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static User.Builder<OpenRtbProtobuf.User> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static User.Builder<OpenRtbProtobuf.User> newProtobufBuilder(OpenRtbProtobuf.User other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static User.Builder<OpenRtbProtobuf.User> newProtobufBuilder(User<?> other)
```
    Returns new Protobuf builder instance based on existing prototype User.
  - protobuf
```
static User.Protobuf protobuf(User<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of User.
  - protobuf
```
static User.Protobuf protobuf(OpenRtbProtobuf.User wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.User> getProtobufClass()
```
    Returns Protobuf class for this struct.
  - getProtobufProtocolClass
```
static Class<AdExchangeProtobuf> getProtobufProtocolClass()
```
    Returns Protobuf protocol class for this struct.
  - getProtobufDescriptor
```
static com.google.protobuf.Descriptors.Descriptor getProtobufDescriptor()
```
    Returns Protobuf descriptor for this struct.
  - getProtobufProtocolDescriptor
```
static com.google.protobuf.Descriptors.FileDescriptor getProtobufProtocolDescriptor()
```
    Returns Protobuf protocol descriptor for this struct.
  - newThriftBuilder
```
static User.Builder<UserThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static User.Builder<UserThrift> newThriftBuilder(UserThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static User.Builder<UserThrift> newThriftBuilder(User<?> other)
```
    Returns new Thrift builder instance based on existing prototype User.
  - thrift
```
static User.Thrift thrift(User<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of User.
  - thrift
```
static User.Thrift thrift(UserThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<UserThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<UserThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface User<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getBuyeruid

isDefaultBuyeruid

getYob

isDefaultYob

getGender

isDefaultGender

getKeywords

isDefaultKeywords

getCustomdata

isDefaultCustomdata

getGeo

isDefaultGeo

getData

isDefaultData

getComparator

compareTo

newNativeImplBuilder

newNativeImplBuilder

nativeImpl

newAvroBuilder

newAvroBuilder

newAvroBuilder

newAvroBuilder

avro

avro

getAvroClass

getAvroSchema

newProtobufBuilder

newProtobufBuilder

newProtobufBuilder

protobuf

protobuf

getProtobufClass

getProtobufProtocolClass

getProtobufDescriptor

getProtobufProtocolDescriptor

newThriftBuilder

newThriftBuilder

newThriftBuilder

thrift

thrift

getThriftClass

getThriftMetadataMap