SeatBid (anoa-tests 3.1.2 API)

All Superinterfaces:

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

All Known Implementing Classes:

SeatBid.Avro, SeatBid.NativeImpl, SeatBid.Protobuf, SeatBid.Thrift
```
public interface SeatBid<T>
extends Supplier<T>, Comparable<SeatBid<?>>, Serializable
```
4.3.2 Seat Bid Object A bid response can contain multiple “seatbid” objects, each on behalf of a different bidder seat. Since a bid request can include multiple impressions, each “seatbid” object can contain multiple bids each pertaining to a different impression on behalf of a seat. Thus, each “bid” object must include the impression ID to which it pertains as well as the bid price. The “group” attribute can be used to specify if a seat is willing to accept any impressions that it can win (default) or if it is only interested in winning any if it can win them all (i.e., all or nothing).

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static SeatBid.Avro`	`avro(SeatBid<?> instance)` Returns a wrapped Avro record based on an instance of SeatBid.
`static SeatBid.Avro`	`avro(SeatBidAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(SeatBid<?> other)`
`T`	`get()` Returns underlying object.
`static Class<SeatBidAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`List<Bid<?>>`	`getBid()` Array of bid objects; each bid object relates to an imp object in the bid request.
`static Comparator<SeatBid<?>>`	`getComparator()` Returns comparator instance for SeatBid objects.
`int`	`getGroup()` “1” means impressions must be won-lost as a group; default is “0”.
`static Class<OpenRtbProtobuf.SeatBid>`	`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.
`String`	`getSeat()` ID of the bidder seat on whose behalf this bid is made.
`static Class<SeatBidThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<SeatBidThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultBid()`
`boolean`	`isDefaultGroup()`
`boolean`	`isDefaultSeat()`
`static SeatBid.NativeImpl`	`nativeImpl(SeatBid<?> instance)` Returns a POJO based on an instance of SeatBid.
`static SeatBid.Builder<SeatBidAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static SeatBid.Builder<SeatBidAvro>`	`newAvroBuilder(SeatBid<?> other)` Returns new Avro builder instance based on existing prototype SeatBid.
`static SeatBid.Builder<SeatBidAvro>`	`newAvroBuilder(SeatBidAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static SeatBid.Builder<SeatBidAvro>`	`newAvroBuilder(SeatBidAvro other)` Returns new Avro builder instance based on existing prototype.
`SeatBid.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static SeatBid.Builder<SeatBid.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static SeatBid.Builder<SeatBid.NativeImpl>`	`newNativeImplBuilder(SeatBid<?> other)` Returns a POJO builder instance based on existing prototype SeatBid.
`static SeatBid.Builder<OpenRtbProtobuf.SeatBid>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static SeatBid.Builder<OpenRtbProtobuf.SeatBid>`	`newProtobufBuilder(OpenRtbProtobuf.SeatBid other)` Returns new Protobuf builder instance based on existing prototype.
`static SeatBid.Builder<OpenRtbProtobuf.SeatBid>`	`newProtobufBuilder(SeatBid<?> other)` Returns new Protobuf builder instance based on existing prototype SeatBid.
`static SeatBid.Builder<SeatBidThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static SeatBid.Builder<SeatBidThrift>`	`newThriftBuilder(SeatBid<?> other)` Returns new Thrift builder instance based on existing prototype SeatBid.
`static SeatBid.Builder<SeatBidThrift>`	`newThriftBuilder(SeatBidThrift other)` Returns new Thrift builder instance based on existing prototype.
`static SeatBid.Protobuf`	`protobuf(OpenRtbProtobuf.SeatBid wrapped)` Wraps an existing Protobuf message.
`static SeatBid.Protobuf`	`protobuf(SeatBid<?> instance)` Returns a wrapped Protobuf message based on an instance of SeatBid.
`static SeatBid.Thrift`	`thrift(SeatBid<?> instance)` Returns a wrapped Thrift struct based on an instance of SeatBid.
`static SeatBid.Thrift`	`thrift(SeatBidThrift 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
```
SeatBid.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getBid
```
List<Bid<?>> getBid()
```
    Array of bid objects; each bid object relates to an imp object in the bid request. Note that, if supported by an exchange, one imp object can have many bid objects.
  - isDefaultBid
```
boolean isDefaultBid()
```
  - getSeat
```
String getSeat()
```
    ID of the bidder seat on whose behalf this bid is made.
  - isDefaultSeat
```
boolean isDefaultSeat()
```
  - getGroup
```
int getGroup()
```
    “1” means impressions must be won-lost as a group; default is “0”.
  - isDefaultGroup
```
boolean isDefaultGroup()
```
  - getComparator
```
static Comparator<SeatBid<?>> getComparator()
```
    Returns comparator instance for SeatBid objects.
  - compareTo
```
default int compareTo(SeatBid<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<SeatBid<?>>
  - newNativeImplBuilder
```
static SeatBid.Builder<SeatBid.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static SeatBid.Builder<SeatBid.NativeImpl> newNativeImplBuilder(SeatBid<?> other)
```
    Returns a POJO builder instance based on existing prototype SeatBid.
  - nativeImpl
```
static SeatBid.NativeImpl nativeImpl(SeatBid<?> instance)
```
    Returns a POJO based on an instance of SeatBid.
  - newAvroBuilder
```
static SeatBid.Builder<SeatBidAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static SeatBid.Builder<SeatBidAvro> newAvroBuilder(SeatBidAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static SeatBid.Builder<SeatBidAvro> newAvroBuilder(SeatBidAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static SeatBid.Builder<SeatBidAvro> newAvroBuilder(SeatBid<?> other)
```
    Returns new Avro builder instance based on existing prototype SeatBid.
  - avro
```
static SeatBid.Avro avro(SeatBid<?> instance)
```
    Returns a wrapped Avro record based on an instance of SeatBid.
  - avro
```
static SeatBid.Avro avro(SeatBidAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<SeatBidAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static SeatBid.Builder<OpenRtbProtobuf.SeatBid> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static SeatBid.Builder<OpenRtbProtobuf.SeatBid> newProtobufBuilder(OpenRtbProtobuf.SeatBid other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static SeatBid.Builder<OpenRtbProtobuf.SeatBid> newProtobufBuilder(SeatBid<?> other)
```
    Returns new Protobuf builder instance based on existing prototype SeatBid.
  - protobuf
```
static SeatBid.Protobuf protobuf(SeatBid<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of SeatBid.
  - protobuf
```
static SeatBid.Protobuf protobuf(OpenRtbProtobuf.SeatBid wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.SeatBid> 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 SeatBid.Builder<SeatBidThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static SeatBid.Builder<SeatBidThrift> newThriftBuilder(SeatBidThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static SeatBid.Builder<SeatBidThrift> newThriftBuilder(SeatBid<?> other)
```
    Returns new Thrift builder instance based on existing prototype SeatBid.
  - thrift
```
static SeatBid.Thrift thrift(SeatBid<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of SeatBid.
  - thrift
```
static SeatBid.Thrift thrift(SeatBidThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<SeatBidThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<SeatBidThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface SeatBid<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getBid

isDefaultBid

getSeat

isDefaultSeat

getGroup

isDefaultGroup

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