open_rtb

Class Content.Avro

java.lang.Object

open_rtb.Content.Avro

All Implemented Interfaces:

Serializable, Comparable<Content<?>>, Supplier<ContentAvro>, Content<ContentAvro>

Enclosing interface:

Content<T>

public static class Content.Avro
extends Object
implements Content<ContentAvro>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface open_rtb.Content

Content.Avro, Content.AvroBuilder, Content.Builder<T>, Content.Comparator, Content.NativeImpl, Content.Protobuf, Content.ProtobufBuilder, Content.Thrift, Content.ThriftBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Avro(byte[] binaryEncoding) Constructs a new Avro instance based on a message's binary encoding.

Method Summary

Modifier and Type	Method and Description
Content.Avro	encoded()
boolean	equals(Object other)
static Content<ContentAvro>	from(byte[] binaryEncoding) Decodes a Avro record.
ContentAvro	get() Returns underlying object.
List<String>	getCat() Array of IAB content categories for the content.
String	getContentrating() Content rating (e.g., MPAA)
String	getContext() Specifies the type of content (game, video, text, etc.).
int	getEmbeddable() From QAG Video Addendum.
int	getEpisode() Content episode number (typically applies to video content).
String	getId() ID uniquely identifying the content.
String	getKeywords() Comma separated list of keywords describing the content.
String	getLanguage() Language of the content.
int	getLen() Length of content (appropriate for video or audio) in seconds.
int	getLivestream() Is content live? E.g., live video stream, live blog.
Producer<?>	getProducer() See Producer Object.
int	getQagmediarating() Media rating of the content, per QAG guidelines.
String	getSeason() Content season.
String	getSeries() Content series.
int	getSourcerelationship() 1 for “direct”; 0 for “indirect”.
String	getTitle() Content title.
String	getUrl() Original URL of the content, for buy-side contextualization or review.
String	getUserrating() User rating of the content (e.g., number of stars, likes, etc.).
int	getVideoquality() Video quality per the IAB’s classification.
int	hashCode()
boolean	isDefaultCat()
boolean	isDefaultContentrating()
boolean	isDefaultContext()
boolean	isDefaultEmbeddable()
boolean	isDefaultEpisode()
boolean	isDefaultId()
boolean	isDefaultKeywords()
boolean	isDefaultLanguage()
boolean	isDefaultLen()
boolean	isDefaultLivestream()
boolean	isDefaultProducer()
boolean	isDefaultQagmediarating()
boolean	isDefaultSeason()
boolean	isDefaultSeries()
boolean	isDefaultSourcerelationship()
boolean	isDefaultTitle()
boolean	isDefaultUrl()
boolean	isDefaultUserrating()
boolean	isDefaultVideoquality()
Content.Builder<ContentAvro>	newBuilder() Creates a new builder based on this object.
byte[]	toByteArray() Returns an Avro binary encoding of this record.
ByteBuffer	toByteBuffer() Returns the Avro binary encoding of this record wrapped in a read-only buffer.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface open_rtb.Content

avro, avro, compareTo, getAvroClass, getAvroSchema, getComparator, getProtobufClass, getProtobufDescriptor, getProtobufProtocolClass, getProtobufProtocolDescriptor, getThriftClass, getThriftMetadataMap, isDefault, nativeImpl, newAvroBuilder, newAvroBuilder, newAvroBuilder, newAvroBuilder, newNativeImplBuilder, newNativeImplBuilder, newProtobufBuilder, newProtobufBuilder, newProtobufBuilder, newThriftBuilder, newThriftBuilder, newThriftBuilder, protobuf, protobuf, thrift, thrift

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Avro

public Avro(byte[] binaryEncoding)

Constructs a new Avro instance based on a message's binary encoding. Only use this if you know what you're doing.

Method Detail

get

public ContentAvro get()

Description copied from interface: Content

Returns underlying object.

Specified by:

get in interface Supplier<ContentAvro>

Specified by:

get in interface Content<ContentAvro>

newBuilder

public Content.Builder<ContentAvro> newBuilder()

Description copied from interface: Content

Creates a new builder based on this object.

Specified by:

newBuilder in interface Content<ContentAvro>

toByteArray

public byte[] toByteArray()

Returns an Avro binary encoding of this record.

toByteBuffer

public ByteBuffer toByteBuffer()

Returns the Avro binary encoding of this record wrapped in a read-only buffer.

getId

public String getId()

Description copied from interface: Content

ID uniquely identifying the content.

Specified by:

getId in interface Content<ContentAvro>

isDefaultId

public boolean isDefaultId()

Specified by:

isDefaultId in interface Content<ContentAvro>

getEpisode

public int getEpisode()

Description copied from interface: Content

Content episode number (typically applies to video content).

Specified by:

getEpisode in interface Content<ContentAvro>

isDefaultEpisode

public boolean isDefaultEpisode()

Specified by:

isDefaultEpisode in interface Content<ContentAvro>

getTitle

public String getTitle()

Description copied from interface: Content

Content title. Video examples: “Search Committee” (television) or “A New Hope” (movie) or “Endgame” (made for web) Non-video example: “Why an Antarctic Glacier Is Melting So Quickly” (Time magazine article)

Specified by:

getTitle in interface Content<ContentAvro>

isDefaultTitle

public boolean isDefaultTitle()

Specified by:

isDefaultTitle in interface Content<ContentAvro>

getSeries

public String getSeries()

Description copied from interface: Content

Content series. Video examples: “The Office” (television) or “Star Wars” (movie) or “Arby ‘N’ The Chief” (made for web) Non-video example: “Ecocentric” (Time magazine blog)

Specified by:

getSeries in interface Content<ContentAvro>

isDefaultSeries

public boolean isDefaultSeries()

Specified by:

isDefaultSeries in interface Content<ContentAvro>

getSeason

public String getSeason()

Description copied from interface: Content

Content season. E.g., “Season 3” (typically applies to video content).

Specified by:

getSeason in interface Content<ContentAvro>

isDefaultSeason

public boolean isDefaultSeason()

Specified by:

isDefaultSeason in interface Content<ContentAvro>

getUrl

public String getUrl()

Description copied from interface: Content

Original URL of the content, for buy-side contextualization or review.

Specified by:

getUrl in interface Content<ContentAvro>

isDefaultUrl

public boolean isDefaultUrl()

Specified by:

isDefaultUrl in interface Content<ContentAvro>

getCat

public List<String> getCat()

Description copied from interface: Content

Array of IAB content categories for the content. See Table 6.1 Content Categories.

Specified by:

getCat in interface Content<ContentAvro>

isDefaultCat

public boolean isDefaultCat()

Specified by:

isDefaultCat in interface Content<ContentAvro>

getVideoquality

public int getVideoquality()

Description copied from interface: Content

Video quality per the IAB’s classification. See Table 6.14 Video Quality.

Specified by:

getVideoquality in interface Content<ContentAvro>

isDefaultVideoquality

public boolean isDefaultVideoquality()

Specified by:

isDefaultVideoquality in interface Content<ContentAvro>

getKeywords

public String getKeywords()

Description copied from interface: Content

Comma separated list of keywords describing the content.

Specified by:

getKeywords in interface Content<ContentAvro>

isDefaultKeywords

public boolean isDefaultKeywords()

Specified by:

isDefaultKeywords in interface Content<ContentAvro>

getContentrating

public String getContentrating()

Description copied from interface: Content

Content rating (e.g., MPAA)

Specified by:

getContentrating in interface Content<ContentAvro>

isDefaultContentrating

public boolean isDefaultContentrating()

Specified by:

isDefaultContentrating in interface Content<ContentAvro>

getUserrating

public String getUserrating()

Description copied from interface: Content

User rating of the content (e.g., number of stars, likes, etc.).

Specified by:

getUserrating in interface Content<ContentAvro>

isDefaultUserrating

public boolean isDefaultUserrating()

Specified by:

isDefaultUserrating in interface Content<ContentAvro>

getContext

public String getContext()

Description copied from interface: Content

Specifies the type of content (game, video, text, etc.). See Table 6.13 Content Context.

Specified by:

getContext in interface Content<ContentAvro>

isDefaultContext

public boolean isDefaultContext()

Specified by:

isDefaultContext in interface Content<ContentAvro>

getLivestream

public int getLivestream()

Description copied from interface: Content

Is content live? E.g., live video stream, live blog. “1” means content is live. “0” means it is not live.

Specified by:

getLivestream in interface Content<ContentAvro>

isDefaultLivestream

public boolean isDefaultLivestream()

Specified by:

isDefaultLivestream in interface Content<ContentAvro>

getSourcerelationship

public int getSourcerelationship()

Description copied from interface: Content

1 for “direct”; 0 for “indirect”.

Specified by:

getSourcerelationship in interface Content<ContentAvro>

isDefaultSourcerelationship

public boolean isDefaultSourcerelationship()

Specified by:

isDefaultSourcerelationship in interface Content<ContentAvro>

getProducer

public Producer<?> getProducer()

Description copied from interface: Content

See Producer Object.

Specified by:

getProducer in interface Content<ContentAvro>

isDefaultProducer

public boolean isDefaultProducer()

Specified by:

isDefaultProducer in interface Content<ContentAvro>

getLen

public int getLen()

Description copied from interface: Content

Length of content (appropriate for video or audio) in seconds.

Specified by:

getLen in interface Content<ContentAvro>

isDefaultLen

public boolean isDefaultLen()

Specified by:

isDefaultLen in interface Content<ContentAvro>

getQagmediarating

public int getQagmediarating()

Description copied from interface: Content

Media rating of the content, per QAG guidelines. See Table 0 QAG Media Ratings for list of possible values.

Specified by:

getQagmediarating in interface Content<ContentAvro>

isDefaultQagmediarating

public boolean isDefaultQagmediarating()

Specified by:

isDefaultQagmediarating in interface Content<ContentAvro>

getEmbeddable

public int getEmbeddable()

Description copied from interface: Content

From QAG Video Addendum. If content can be embedded (such as an embeddable video player) this value should be set to “1”. If content cannot be embedded, then this should be set to “0”.

Specified by:

getEmbeddable in interface Content<ContentAvro>

isDefaultEmbeddable

public boolean isDefaultEmbeddable()

Specified by:

isDefaultEmbeddable in interface Content<ContentAvro>

getLanguage

public String getLanguage()

Description copied from interface: Content

Language of the content. Use alpha-2/ISO 639-1 codes.

Specified by:

getLanguage in interface Content<ContentAvro>

isDefaultLanguage

public boolean isDefaultLanguage()

Specified by:

isDefaultLanguage in interface Content<ContentAvro>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

encoded

public Content.Avro encoded()

from

public static Content<ContentAvro> from(byte[] binaryEncoding)
                                 throws IOException

Decodes a Avro record.

Throws:

IOException