Deal (anoa-tests 3.1.2 API)

All Superinterfaces:

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

All Known Implementing Classes:

Deal.Avro, Deal.NativeImpl, Deal.Protobuf, Deal.Thrift
```
public interface Deal<T>
extends Supplier<T>, Comparable<Deal<?>>, Serializable
```
3.3.17 Direct Deals Object A “deal” object constitutes a deal struck a priori between a buyer and a seller and indicates that this impression is available under the terms of that deal.

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Deal.Avro`	`avro(Deal<?> instance)` Returns a wrapped Avro record based on an instance of Deal.
`static Deal.Avro`	`avro(DealAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Deal<?> other)`
`T`	`get()` Returns underlying object.
`int`	`getAt()` Auction type.
`static Class<DealAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`double`	`getBidfloor()` Bid floor for this impression (in CPM of bidfloorcur).
`String`	`getBidfloorcur()` If bid floor is specified and multiple currencies supported per bid request, then currency should be specified here using ISO- 4217 alphabetic codes.
`static Comparator<Deal<?>>`	`getComparator()` Returns comparator instance for Deal objects.
`String`	`getId()` A unique identifier for the direct deal.
`static Class<OpenRtbProtobuf.Deal>`	`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<DealThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<DealThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`List<String>`	`getWadomain()` Array of advertiser domains allowed to bid on this Direct Deal.
`List<String>`	`getWseat()` Array of buyer seats allowed to bid on this Direct Deal.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultAt()`
`boolean`	`isDefaultBidfloor()`
`boolean`	`isDefaultBidfloorcur()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultWadomain()`
`boolean`	`isDefaultWseat()`
`static Deal.NativeImpl`	`nativeImpl(Deal<?> instance)` Returns a POJO based on an instance of Deal.
`static Deal.Builder<DealAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Deal.Builder<DealAvro>`	`newAvroBuilder(Deal<?> other)` Returns new Avro builder instance based on existing prototype Deal.
`static Deal.Builder<DealAvro>`	`newAvroBuilder(DealAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Deal.Builder<DealAvro>`	`newAvroBuilder(DealAvro other)` Returns new Avro builder instance based on existing prototype.
`Deal.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Deal.Builder<Deal.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Deal.Builder<Deal.NativeImpl>`	`newNativeImplBuilder(Deal<?> other)` Returns a POJO builder instance based on existing prototype Deal.
`static Deal.Builder<OpenRtbProtobuf.Deal>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Deal.Builder<OpenRtbProtobuf.Deal>`	`newProtobufBuilder(Deal<?> other)` Returns new Protobuf builder instance based on existing prototype Deal.
`static Deal.Builder<OpenRtbProtobuf.Deal>`	`newProtobufBuilder(OpenRtbProtobuf.Deal other)` Returns new Protobuf builder instance based on existing prototype.
`static Deal.Builder<DealThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Deal.Builder<DealThrift>`	`newThriftBuilder(Deal<?> other)` Returns new Thrift builder instance based on existing prototype Deal.
`static Deal.Builder<DealThrift>`	`newThriftBuilder(DealThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Deal.Protobuf`	`protobuf(Deal<?> instance)` Returns a wrapped Protobuf message based on an instance of Deal.
`static Deal.Protobuf`	`protobuf(OpenRtbProtobuf.Deal wrapped)` Wraps an existing Protobuf message.
`static Deal.Thrift`	`thrift(Deal<?> instance)` Returns a wrapped Thrift struct based on an instance of Deal.
`static Deal.Thrift`	`thrift(DealThrift 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
```
Deal.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
String getId()
```
    A unique identifier for the direct deal.
  - isDefaultId
```
boolean isDefaultId()
```
  - getBidfloor
```
double getBidfloor()
```
    Bid floor for this impression (in CPM of bidfloorcur).
  - isDefaultBidfloor
```
boolean isDefaultBidfloor()
```
  - getBidfloorcur
```
String getBidfloorcur()
```
    If bid floor is specified and multiple currencies supported per bid request, then currency should be specified here using ISO- 4217 alphabetic codes. Note, this may be different from bid currency returned by bidder, if this is allowed on an exchange.
  - isDefaultBidfloorcur
```
boolean isDefaultBidfloorcur()
```
  - getWseat
```
List<String> getWseat()
```
    Array of buyer seats allowed to bid on this Direct Deal. Seats are an optional feature of an exchange. For example, [“4”,”34”,”82”,”45”] indicates that only advertisers using these exchange seats are allowed to bid on this direct deal.
  - isDefaultWseat
```
boolean isDefaultWseat()
```
  - getWadomain
```
List<String> getWadomain()
```
    Array of advertiser domains allowed to bid on this Direct Deal. For example, [“advertiser1.com”,”advertiser2.com”] indicates that only the listed advertisers are allowed to bid on this direct deal.
  - isDefaultWadomain
```
boolean isDefaultWadomain()
```
  - getAt
```
int getAt()
```
    Auction type. If “1”, then first price auction. If “2”, then second price auction. If “3”, the passed bidfloor indicates the apriori agreed upon deal price. Additional auction types can be defined as per the exchange’s business rules.
  - isDefaultAt
```
boolean isDefaultAt()
```
  - getComparator
```
static Comparator<Deal<?>> getComparator()
```
    Returns comparator instance for Deal objects.
  - compareTo
```
default int compareTo(Deal<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Deal<?>>
  - newNativeImplBuilder
```
static Deal.Builder<Deal.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Deal.Builder<Deal.NativeImpl> newNativeImplBuilder(Deal<?> other)
```
    Returns a POJO builder instance based on existing prototype Deal.
  - nativeImpl
```
static Deal.NativeImpl nativeImpl(Deal<?> instance)
```
    Returns a POJO based on an instance of Deal.
  - newAvroBuilder
```
static Deal.Builder<DealAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Deal.Builder<DealAvro> newAvroBuilder(DealAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Deal.Builder<DealAvro> newAvroBuilder(DealAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Deal.Builder<DealAvro> newAvroBuilder(Deal<?> other)
```
    Returns new Avro builder instance based on existing prototype Deal.
  - avro
```
static Deal.Avro avro(Deal<?> instance)
```
    Returns a wrapped Avro record based on an instance of Deal.
  - avro
```
static Deal.Avro avro(DealAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<DealAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Deal.Builder<OpenRtbProtobuf.Deal> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Deal.Builder<OpenRtbProtobuf.Deal> newProtobufBuilder(OpenRtbProtobuf.Deal other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Deal.Builder<OpenRtbProtobuf.Deal> newProtobufBuilder(Deal<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Deal.
  - protobuf
```
static Deal.Protobuf protobuf(Deal<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Deal.
  - protobuf
```
static Deal.Protobuf protobuf(OpenRtbProtobuf.Deal wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Deal> 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 Deal.Builder<DealThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Deal.Builder<DealThrift> newThriftBuilder(DealThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Deal.Builder<DealThrift> newThriftBuilder(Deal<?> other)
```
    Returns new Thrift builder instance based on existing prototype Deal.
  - thrift
```
static Deal.Thrift thrift(Deal<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Deal.
  - thrift
```
static Deal.Thrift thrift(DealThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<DealThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<DealThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Deal<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getBidfloor

isDefaultBidfloor

getBidfloorcur

isDefaultBidfloorcur

getWseat

isDefaultWseat

getWadomain

isDefaultWadomain

getAt

isDefaultAt

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