BidThrift (anoa-tests 3.1.2 API)

java.lang.Object
- open_rtb.BidThrift

All Implemented Interfaces:: Serializable, Cloneable, Comparable<BidThrift>, TBase<BidThrift,BidThrift._Fields>

@Generated(value="Autogenerated by Thrift Compiler (0.9.3)",
           date="2016-12-21")
public class BidThrift
extends Object
implements TBase<BidThrift,BidThrift._Fields>, Serializable, Cloneable, Comparable<BidThrift>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BidThrift._Fields` The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`adid` ID that references the ad to be served if the bid wins.
`String`	`adm` Actual ad markup.
`List<String>`	`adomain` Advertiser’s primary or top-level domain for advertiser checking.
`List<Short>`	`attr` Array of creative attributes.
`String`	`cid` Campaign ID or similar that appears within the ad markup.
`String`	`crid` Creative ID for reporting content issues or defects.
`String`	`dealid` A unique identifier for the direct deal associated with the bid.
`int`	`h` Height of the ad in pixels.
`String`	`id` ID for the bid object chosen by the bidder for tracking and debugging purposes.
`String`	`impid` ID of the impression object to which this bid applies.
`String`	`lurl` Sample image URL (without cache busting) for content checking.
`static Map<BidThrift._Fields,FieldMetaData>`	`metaDataMap`
`String`	`nurl` Win notice URL.
`double`	`price` Bid price in CPM.
`int`	`w` Width of the ad in pixels.

Constructor Summary

Constructors
Constructor and Description

BidThrift()

BidThrift(BidThrift other)
Performs a deep copy on other.

Constructors
Constructor and Description
`BidThrift()`
`BidThrift(BidThrift other)` Performs a deep copy on other.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToAdomain(String elem)`
`void`	`addToAttr(short elem)`
`void`	`clear()`
`int`	`compareTo(BidThrift other)`
`BidThrift`	`deepCopy()`
`boolean`	`equals(BidThrift that)`
`boolean`	`equals(Object that)`
`BidThrift._Fields`	`fieldForId(int fieldId)`
`String`	`getAdid()` ID that references the ad to be served if the bid wins.
`String`	`getAdm()` Actual ad markup.
`List<String>`	`getAdomain()` Advertiser’s primary or top-level domain for advertiser checking.
`Iterator<String>`	`getAdomainIterator()`
`int`	`getAdomainSize()`
`List<Short>`	`getAttr()` Array of creative attributes.
`Iterator<Short>`	`getAttrIterator()`
`int`	`getAttrSize()`
`String`	`getCid()` Campaign ID or similar that appears within the ad markup.
`String`	`getCrid()` Creative ID for reporting content issues or defects.
`String`	`getDealid()` A unique identifier for the direct deal associated with the bid.
`Object`	`getFieldValue(BidThrift._Fields field)`
`int`	`getH()` Height of the ad in pixels.
`String`	`getId()` ID for the bid object chosen by the bidder for tracking and debugging purposes.
`String`	`getImpid()` ID of the impression object to which this bid applies.
`String`	`getLurl()` Sample image URL (without cache busting) for content checking.
`String`	`getNurl()` Win notice URL.
`double`	`getPrice()` Bid price in CPM.
`int`	`getW()` Width of the ad in pixels.
`int`	`hashCode()`
`boolean`	`isSet(BidThrift._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetAdid()` Returns true if field adid is set (has been assigned a value) and false otherwise
`boolean`	`isSetAdm()` Returns true if field adm is set (has been assigned a value) and false otherwise
`boolean`	`isSetAdomain()` Returns true if field adomain is set (has been assigned a value) and false otherwise
`boolean`	`isSetAttr()` Returns true if field attr is set (has been assigned a value) and false otherwise
`boolean`	`isSetCid()` Returns true if field cid is set (has been assigned a value) and false otherwise
`boolean`	`isSetCrid()` Returns true if field crid is set (has been assigned a value) and false otherwise
`boolean`	`isSetDealid()` Returns true if field dealid is set (has been assigned a value) and false otherwise
`boolean`	`isSetH()` Returns true if field h is set (has been assigned a value) and false otherwise
`boolean`	`isSetId()` Returns true if field id is set (has been assigned a value) and false otherwise
`boolean`	`isSetImpid()` Returns true if field impid is set (has been assigned a value) and false otherwise
`boolean`	`isSetLurl()` Returns true if field lurl is set (has been assigned a value) and false otherwise
`boolean`	`isSetNurl()` Returns true if field nurl is set (has been assigned a value) and false otherwise
`boolean`	`isSetPrice()` Returns true if field price is set (has been assigned a value) and false otherwise
`boolean`	`isSetW()` Returns true if field w is set (has been assigned a value) and false otherwise
`void`	`read(TProtocol iprot)`
`BidThrift`	`setAdid(String adid)` ID that references the ad to be served if the bid wins.
`void`	`setAdidIsSet(boolean value)`
`BidThrift`	`setAdm(String adm)` Actual ad markup.
`void`	`setAdmIsSet(boolean value)`
`BidThrift`	`setAdomain(List<String> adomain)` Advertiser’s primary or top-level domain for advertiser checking.
`void`	`setAdomainIsSet(boolean value)`
`BidThrift`	`setAttr(List<Short> attr)` Array of creative attributes.
`void`	`setAttrIsSet(boolean value)`
`BidThrift`	`setCid(String cid)` Campaign ID or similar that appears within the ad markup.
`void`	`setCidIsSet(boolean value)`
`BidThrift`	`setCrid(String crid)` Creative ID for reporting content issues or defects.
`void`	`setCridIsSet(boolean value)`
`BidThrift`	`setDealid(String dealid)` A unique identifier for the direct deal associated with the bid.
`void`	`setDealidIsSet(boolean value)`
`void`	`setFieldValue(BidThrift._Fields field, Object value)`
`BidThrift`	`setH(int h)` Height of the ad in pixels.
`void`	`setHIsSet(boolean value)`
`BidThrift`	`setId(String id)` ID for the bid object chosen by the bidder for tracking and debugging purposes.
`void`	`setIdIsSet(boolean value)`
`BidThrift`	`setImpid(String impid)` ID of the impression object to which this bid applies.
`void`	`setImpidIsSet(boolean value)`
`BidThrift`	`setLurl(String lurl)` Sample image URL (without cache busting) for content checking.
`void`	`setLurlIsSet(boolean value)`
`BidThrift`	`setNurl(String nurl)` Win notice URL.
`void`	`setNurlIsSet(boolean value)`
`BidThrift`	`setPrice(double price)` Bid price in CPM.
`void`	`setPriceIsSet(boolean value)`
`BidThrift`	`setW(int w)` Width of the ad in pixels.
`void`	`setWIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetAdid()`
`void`	`unsetAdm()`
`void`	`unsetAdomain()`
`void`	`unsetAttr()`
`void`	`unsetCid()`
`void`	`unsetCrid()`
`void`	`unsetDealid()`
`void`	`unsetH()`
`void`	`unsetId()`
`void`	`unsetImpid()`
`void`	`unsetLurl()`
`void`	`unsetNurl()`
`void`	`unsetPrice()`
`void`	`unsetW()`
`void`	`validate()`
`void`	`write(TProtocol oprot)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
public String id
```
    ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
  - impid
```
public String impid
```
    ID of the impression object to which this bid applies.
  - price
```
public double price
```
    Bid price in CPM. WARNING/Best Practice Note: Although this value is a float, OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
  - adid
```
public String adid
```
    ID that references the ad to be served if the bid wins.
  - nurl
```
public String nurl
```
    Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.
  - adm
```
public String adm
```
    Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
  - adomain
```
public List<String> adomain
```
    Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
  - lurl
```
public String lurl
```
    Sample image URL (without cache busting) for content checking.
  - cid
```
public String cid
```
    Campaign ID or similar that appears within the ad markup.
  - crid
```
public String crid
```
    Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
  - attr
```
public List<Short> attr
```
    Array of creative attributes. See Table 6.3 Creative Attributes.
  - dealid
```
public String dealid
```
    A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object.
  - w
```
public int w
```
    Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - h
```
public int h
```
    Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - metaDataMap
```
public static final Map<BidThrift._Fields,FieldMetaData> metaDataMap
```
- Constructor Detail
  - BidThrift
```
public BidThrift()
```
  - BidThrift
```
public BidThrift(BidThrift other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public BidThrift deepCopy()
```
    Specified by:
    
    deepCopy in interface TBase<BidThrift,BidThrift._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface TBase<BidThrift,BidThrift._Fields>
  - getId
```
public String getId()
```
    ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
  - setId
```
public BidThrift setId(String id)
```
    ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
  - unsetId
```
public void unsetId()
```
  - isSetId
```
public boolean isSetId()
```
    Returns true if field id is set (has been assigned a value) and false otherwise
  - setIdIsSet
```
public void setIdIsSet(boolean value)
```
  - getImpid
```
public String getImpid()
```
    ID of the impression object to which this bid applies.
  - setImpid
```
public BidThrift setImpid(String impid)
```
    ID of the impression object to which this bid applies.
  - unsetImpid
```
public void unsetImpid()
```
  - isSetImpid
```
public boolean isSetImpid()
```
    Returns true if field impid is set (has been assigned a value) and false otherwise
  - setImpidIsSet
```
public void setImpidIsSet(boolean value)
```
  - getPrice
```
public double getPrice()
```
    Bid price in CPM. WARNING/Best Practice Note: Although this value is a float, OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
  - setPrice
```
public BidThrift setPrice(double price)
```
    Bid price in CPM. WARNING/Best Practice Note: Although this value is a float, OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
  - unsetPrice
```
public void unsetPrice()
```
  - isSetPrice
```
public boolean isSetPrice()
```
    Returns true if field price is set (has been assigned a value) and false otherwise
  - setPriceIsSet
```
public void setPriceIsSet(boolean value)
```
  - getAdid
```
public String getAdid()
```
    ID that references the ad to be served if the bid wins.
  - setAdid
```
public BidThrift setAdid(String adid)
```
    ID that references the ad to be served if the bid wins.
  - unsetAdid
```
public void unsetAdid()
```
  - isSetAdid
```
public boolean isSetAdid()
```
    Returns true if field adid is set (has been assigned a value) and false otherwise
  - setAdidIsSet
```
public void setAdidIsSet(boolean value)
```
  - getNurl
```
public String getNurl()
```
    Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.
  - setNurl
```
public BidThrift setNurl(String nurl)
```
    Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.
  - unsetNurl
```
public void unsetNurl()
```
  - isSetNurl
```
public boolean isSetNurl()
```
    Returns true if field nurl is set (has been assigned a value) and false otherwise
  - setNurlIsSet
```
public void setNurlIsSet(boolean value)
```
  - getAdm
```
public String getAdm()
```
    Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
  - setAdm
```
public BidThrift setAdm(String adm)
```
    Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
  - unsetAdm
```
public void unsetAdm()
```
  - isSetAdm
```
public boolean isSetAdm()
```
    Returns true if field adm is set (has been assigned a value) and false otherwise
  - setAdmIsSet
```
public void setAdmIsSet(boolean value)
```
  - getAdomainSize
```
public int getAdomainSize()
```
  - getAdomainIterator
```
public Iterator<String> getAdomainIterator()
```
  - addToAdomain
```
public void addToAdomain(String elem)
```
  - getAdomain
```
public List<String> getAdomain()
```
    Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
  - setAdomain
```
public BidThrift setAdomain(List<String> adomain)
```
    Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
  - unsetAdomain
```
public void unsetAdomain()
```
  - isSetAdomain
```
public boolean isSetAdomain()
```
    Returns true if field adomain is set (has been assigned a value) and false otherwise
  - setAdomainIsSet
```
public void setAdomainIsSet(boolean value)
```
  - getLurl
```
public String getLurl()
```
    Sample image URL (without cache busting) for content checking.
  - setLurl
```
public BidThrift setLurl(String lurl)
```
    Sample image URL (without cache busting) for content checking.
  - unsetLurl
```
public void unsetLurl()
```
  - isSetLurl
```
public boolean isSetLurl()
```
    Returns true if field lurl is set (has been assigned a value) and false otherwise
  - setLurlIsSet
```
public void setLurlIsSet(boolean value)
```
  - getCid
```
public String getCid()
```
    Campaign ID or similar that appears within the ad markup.
  - setCid
```
public BidThrift setCid(String cid)
```
    Campaign ID or similar that appears within the ad markup.
  - unsetCid
```
public void unsetCid()
```
  - isSetCid
```
public boolean isSetCid()
```
    Returns true if field cid is set (has been assigned a value) and false otherwise
  - setCidIsSet
```
public void setCidIsSet(boolean value)
```
  - getCrid
```
public String getCrid()
```
    Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
  - setCrid
```
public BidThrift setCrid(String crid)
```
    Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
  - unsetCrid
```
public void unsetCrid()
```
  - isSetCrid
```
public boolean isSetCrid()
```
    Returns true if field crid is set (has been assigned a value) and false otherwise
  - setCridIsSet
```
public void setCridIsSet(boolean value)
```
  - getAttrSize
```
public int getAttrSize()
```
  - getAttrIterator
```
public Iterator<Short> getAttrIterator()
```
  - addToAttr
```
public void addToAttr(short elem)
```
  - getAttr
```
public List<Short> getAttr()
```
    Array of creative attributes. See Table 6.3 Creative Attributes.
  - setAttr
```
public BidThrift setAttr(List<Short> attr)
```
    Array of creative attributes. See Table 6.3 Creative Attributes.
  - unsetAttr
```
public void unsetAttr()
```
  - isSetAttr
```
public boolean isSetAttr()
```
    Returns true if field attr is set (has been assigned a value) and false otherwise
  - setAttrIsSet
```
public void setAttrIsSet(boolean value)
```
  - getDealid
```
public String getDealid()
```
    A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object.
  - setDealid
```
public BidThrift setDealid(String dealid)
```
    A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object.
  - unsetDealid
```
public void unsetDealid()
```
  - isSetDealid
```
public boolean isSetDealid()
```
    Returns true if field dealid is set (has been assigned a value) and false otherwise
  - setDealidIsSet
```
public void setDealidIsSet(boolean value)
```
  - getW
```
public int getW()
```
    Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - setW
```
public BidThrift setW(int w)
```
    Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - unsetW
```
public void unsetW()
```
  - isSetW
```
public boolean isSetW()
```
    Returns true if field w is set (has been assigned a value) and false otherwise
  - setWIsSet
```
public void setWIsSet(boolean value)
```
  - getH
```
public int getH()
```
    Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - setH
```
public BidThrift setH(int h)
```
    Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - unsetH
```
public void unsetH()
```
  - isSetH
```
public boolean isSetH()
```
    Returns true if field h is set (has been assigned a value) and false otherwise
  - setHIsSet
```
public void setHIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(BidThrift._Fields field,
                          Object value)
```
    Specified by:
    
    setFieldValue in interface TBase<BidThrift,BidThrift._Fields>
  - getFieldValue
```
public Object getFieldValue(BidThrift._Fields field)
```
    Specified by:
    
    getFieldValue in interface TBase<BidThrift,BidThrift._Fields>
  - isSet
```
public boolean isSet(BidThrift._Fields field)
```
    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
    
    Specified by:
    
    isSet in interface TBase<BidThrift,BidThrift._Fields>
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(BidThrift that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(BidThrift other)
```
    Specified by:
    
    compareTo in interface Comparable<BidThrift>
  - fieldForId
```
public BidThrift._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface TBase<BidThrift,BidThrift._Fields>
  - read
```
public void read(TProtocol iprot)
          throws TException
```
    Specified by:
    
    read in interface TBase<BidThrift,BidThrift._Fields>
    
    Throws:
    
    TException
  - write
```
public void write(TProtocol oprot)
           throws TException
```
    Specified by:
    
    write in interface TBase<BidThrift,BidThrift._Fields>
    
    Throws:
    
    TException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validate
```
public void validate()
              throws TException
```
    Throws:
    
    TException

Class BidThrift

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

impid

price

adid

nurl

adm

adomain

lurl

cid

crid

attr

dealid

w

h

metaDataMap

Constructor Detail

BidThrift

BidThrift

Method Detail

deepCopy

clear

getId

setId

unsetId

isSetId

setIdIsSet

getImpid

setImpid

unsetImpid

isSetImpid

setImpidIsSet

getPrice

setPrice

unsetPrice

isSetPrice

setPriceIsSet

getAdid

setAdid

unsetAdid

isSetAdid

setAdidIsSet

getNurl

setNurl

unsetNurl

isSetNurl

setNurlIsSet

getAdm

setAdm

unsetAdm

isSetAdm

setAdmIsSet

getAdomainSize

getAdomainIterator

addToAdomain

getAdomain

setAdomain

unsetAdomain

isSetAdomain

setAdomainIsSet

getLurl

setLurl

unsetLurl

isSetLurl

setLurlIsSet

getCid

setCid

unsetCid

isSetCid

setCidIsSet

getCrid

setCrid

unsetCrid

isSetCrid