BidResponse (anoa-tests 3.1.2 API)

All Superinterfaces:

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

All Known Implementing Classes:

BidResponse.Avro, BidResponse.NativeImpl, BidResponse.Protobuf, BidResponse.Thrift
```
public interface BidResponse<T>
extends Supplier<T>, Comparable<BidResponse<?>>, Serializable
```
4.3.1 Bid Response Object The top-level bid response object is defined below. The “id” attribute is a reflection of the bid request ID for logging purposes. Similarly, “bidid” is an optional response tracking ID for bidders. If specified, it can be included in the subsequent win notice call if the bidder wins. At least one “seatbid” object is required, which contains a bid on at least one impression. Other attributes are optional since an exchange may establish default values. No-Bids on all impressions should be indicated as a HTTP 204 response. For no-bids on specific impressions, the bidder should omit these from the bid response.

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static BidResponse.Avro`	`avro(BidResponse<?> instance)` Returns a wrapped Avro record based on an instance of BidResponse.
`static BidResponse.Avro`	`avro(BidResponseAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(BidResponse<?> other)`
`T`	`get()` Returns underlying object.
`static Class<BidResponseAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`String`	`getBidid()` Bid response ID to assist tracking for bidders.
`static Comparator<BidResponse<?>>`	`getComparator()` Returns comparator instance for BidResponse objects.
`String`	`getCur()` Bid currency using ISO-4217 alphabetic codes; default is “USD”.
`String`	`getCustomdata()` This is an optional feature, which allows a bidder to set data in the exchange’s cookie.
`String`	`getId()` ID of the bid request.
`int`	`getNbr()` Reason for not bidding.
`static Class<OpenRtbProtobuf.BidResponse>`	`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.
`List<SeatBid<?>>`	`getSeatbid()` Array of seatbid objects.
`static Class<BidResponseThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<BidResponseThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultBidid()`
`boolean`	`isDefaultCur()`
`boolean`	`isDefaultCustomdata()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultNbr()`
`boolean`	`isDefaultSeatbid()`
`static BidResponse.NativeImpl`	`nativeImpl(BidResponse<?> instance)` Returns a POJO based on an instance of BidResponse.
`static BidResponse.Builder<BidResponseAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static BidResponse.Builder<BidResponseAvro>`	`newAvroBuilder(BidResponse<?> other)` Returns new Avro builder instance based on existing prototype BidResponse.
`static BidResponse.Builder<BidResponseAvro>`	`newAvroBuilder(BidResponseAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static BidResponse.Builder<BidResponseAvro>`	`newAvroBuilder(BidResponseAvro other)` Returns new Avro builder instance based on existing prototype.
`BidResponse.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static BidResponse.Builder<BidResponse.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static BidResponse.Builder<BidResponse.NativeImpl>`	`newNativeImplBuilder(BidResponse<?> other)` Returns a POJO builder instance based on existing prototype BidResponse.
`static BidResponse.Builder<OpenRtbProtobuf.BidResponse>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static BidResponse.Builder<OpenRtbProtobuf.BidResponse>`	`newProtobufBuilder(BidResponse<?> other)` Returns new Protobuf builder instance based on existing prototype BidResponse.
`static BidResponse.Builder<OpenRtbProtobuf.BidResponse>`	`newProtobufBuilder(OpenRtbProtobuf.BidResponse other)` Returns new Protobuf builder instance based on existing prototype.
`static BidResponse.Builder<BidResponseThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static BidResponse.Builder<BidResponseThrift>`	`newThriftBuilder(BidResponse<?> other)` Returns new Thrift builder instance based on existing prototype BidResponse.
`static BidResponse.Builder<BidResponseThrift>`	`newThriftBuilder(BidResponseThrift other)` Returns new Thrift builder instance based on existing prototype.
`static BidResponse.Protobuf`	`protobuf(BidResponse<?> instance)` Returns a wrapped Protobuf message based on an instance of BidResponse.
`static BidResponse.Protobuf`	`protobuf(OpenRtbProtobuf.BidResponse wrapped)` Wraps an existing Protobuf message.
`static BidResponse.Thrift`	`thrift(BidResponse<?> instance)` Returns a wrapped Thrift struct based on an instance of BidResponse.
`static BidResponse.Thrift`	`thrift(BidResponseThrift 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
```
BidResponse.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
String getId()
```
    ID of the bid request.
  - isDefaultId
```
boolean isDefaultId()
```
  - getSeatbid
```
List<SeatBid<?>> getSeatbid()
```
    Array of seatbid objects.
  - isDefaultSeatbid
```
boolean isDefaultSeatbid()
```
  - getBidid
```
String getBidid()
```
    Bid response ID to assist tracking for bidders. This value is chosen by the bidder for cross-reference.
  - isDefaultBidid
```
boolean isDefaultBidid()
```
  - getCur
```
String getCur()
```
    Bid currency using ISO-4217 alphabetic codes; default is “USD”.
  - isDefaultCur
```
boolean isDefaultCur()
```
  - getCustomdata
```
String getCustomdata()
```
    This is an optional feature, which allows a bidder to set data in the exchange’s cookie. The string may be in base85 cookie safe characters, and be in any format. This may be useful for storing user features. Note: Proper JSON encoding must be used to include “escaped” quotation marks.
  - isDefaultCustomdata
```
boolean isDefaultCustomdata()
```
  - getNbr
```
int getNbr()
```
    Reason for not bidding. See Table 6.19 No-Bid Reason Codes.
  - isDefaultNbr
```
boolean isDefaultNbr()
```
  - getComparator
```
static Comparator<BidResponse<?>> getComparator()
```
    Returns comparator instance for BidResponse objects.
  - compareTo
```
default int compareTo(BidResponse<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<BidResponse<?>>
  - newNativeImplBuilder
```
static BidResponse.Builder<BidResponse.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static BidResponse.Builder<BidResponse.NativeImpl> newNativeImplBuilder(BidResponse<?> other)
```
    Returns a POJO builder instance based on existing prototype BidResponse.
  - nativeImpl
```
static BidResponse.NativeImpl nativeImpl(BidResponse<?> instance)
```
    Returns a POJO based on an instance of BidResponse.
  - newAvroBuilder
```
static BidResponse.Builder<BidResponseAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static BidResponse.Builder<BidResponseAvro> newAvroBuilder(BidResponseAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static BidResponse.Builder<BidResponseAvro> newAvroBuilder(BidResponseAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static BidResponse.Builder<BidResponseAvro> newAvroBuilder(BidResponse<?> other)
```
    Returns new Avro builder instance based on existing prototype BidResponse.
  - avro
```
static BidResponse.Avro avro(BidResponse<?> instance)
```
    Returns a wrapped Avro record based on an instance of BidResponse.
  - avro
```
static BidResponse.Avro avro(BidResponseAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<BidResponseAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static BidResponse.Builder<OpenRtbProtobuf.BidResponse> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static BidResponse.Builder<OpenRtbProtobuf.BidResponse> newProtobufBuilder(OpenRtbProtobuf.BidResponse other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static BidResponse.Builder<OpenRtbProtobuf.BidResponse> newProtobufBuilder(BidResponse<?> other)
```
    Returns new Protobuf builder instance based on existing prototype BidResponse.
  - protobuf
```
static BidResponse.Protobuf protobuf(BidResponse<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of BidResponse.
  - protobuf
```
static BidResponse.Protobuf protobuf(OpenRtbProtobuf.BidResponse wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.BidResponse> 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 BidResponse.Builder<BidResponseThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static BidResponse.Builder<BidResponseThrift> newThriftBuilder(BidResponseThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static BidResponse.Builder<BidResponseThrift> newThriftBuilder(BidResponse<?> other)
```
    Returns new Thrift builder instance based on existing prototype BidResponse.
  - thrift
```
static BidResponse.Thrift thrift(BidResponse<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of BidResponse.
  - thrift
```
static BidResponse.Thrift thrift(BidResponseThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<BidResponseThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<BidResponseThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface BidResponse<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getSeatbid

isDefaultSeatbid

getBidid

isDefaultBidid

getCur

isDefaultCur

getCustomdata

isDefaultCustomdata

getNbr

isDefaultNbr

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