Site (anoa-tests 3.1.2 API)

All Superinterfaces:

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

All Known Implementing Classes:

Site.Avro, Site.NativeImpl, Site.Protobuf, Site.Thrift
```
public interface Site<T>
extends Supplier<T>, Comparable<Site<?>>, Serializable
```
3.3.5 Site Object A site object should be included if the ad supported content is part of a website (as opposed to an application). A bid request must not contain both a site object and an app object. The site object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown. At a minimum, it’s useful to provide a page URL or a site ID, but this is not strictly required.

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Site.Avro`	`avro(Site<?> instance)` Returns a wrapped Avro record based on an instance of Site.
`static Site.Avro`	`avro(SiteAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Site<?> other)`
`T`	`get()` Returns underlying object.
`static Class<SiteAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`List<String>`	`getCat()` Array of IAB content categories for the overall site.
`static Comparator<Site<?>>`	`getComparator()` Returns comparator instance for Site objects.
`Content<?>`	`getContent()` See Content Object.
`String`	`getDomain()` Domain of the site, used for advertiser side blocking.
`String`	`getId()` Site ID on the exchange.
`String`	`getKeywords()` List of keywords describing this site in a comma separated string.
`String`	`getName()` Site name (may be masked at publisher’s request).
`String`	`getPage()` URL of the page where the impression will be shown.
`List<String>`	`getPagecat()` Array of IAB content categories for the current page.
`int`	`getPrivacypolicy()` Specifies whether the site has a privacy policy.
`static Class<OpenRtbProtobuf.Site>`	`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.
`Publisher<?>`	`getPublisher()` See Publisher Object.
`String`	`getRef()` Referrer URL that caused navigation to the current page.
`String`	`getSearch()` Search string that caused navigation to the current page.
`List<String>`	`getSectioncat()` Array of IAB content categories for the current subsection of the site.
`static Class<SiteThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<SiteThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultCat()`
`boolean`	`isDefaultContent()`
`boolean`	`isDefaultDomain()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultKeywords()`
`boolean`	`isDefaultName()`
`boolean`	`isDefaultPage()`
`boolean`	`isDefaultPagecat()`
`boolean`	`isDefaultPrivacypolicy()`
`boolean`	`isDefaultPublisher()`
`boolean`	`isDefaultRef()`
`boolean`	`isDefaultSearch()`
`boolean`	`isDefaultSectioncat()`
`static Site.NativeImpl`	`nativeImpl(Site<?> instance)` Returns a POJO based on an instance of Site.
`static Site.Builder<SiteAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Site.Builder<SiteAvro>`	`newAvroBuilder(Site<?> other)` Returns new Avro builder instance based on existing prototype Site.
`static Site.Builder<SiteAvro>`	`newAvroBuilder(SiteAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Site.Builder<SiteAvro>`	`newAvroBuilder(SiteAvro other)` Returns new Avro builder instance based on existing prototype.
`Site.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Site.Builder<Site.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Site.Builder<Site.NativeImpl>`	`newNativeImplBuilder(Site<?> other)` Returns a POJO builder instance based on existing prototype Site.
`static Site.Builder<OpenRtbProtobuf.Site>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Site.Builder<OpenRtbProtobuf.Site>`	`newProtobufBuilder(OpenRtbProtobuf.Site other)` Returns new Protobuf builder instance based on existing prototype.
`static Site.Builder<OpenRtbProtobuf.Site>`	`newProtobufBuilder(Site<?> other)` Returns new Protobuf builder instance based on existing prototype Site.
`static Site.Builder<SiteThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Site.Builder<SiteThrift>`	`newThriftBuilder(Site<?> other)` Returns new Thrift builder instance based on existing prototype Site.
`static Site.Builder<SiteThrift>`	`newThriftBuilder(SiteThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Site.Protobuf`	`protobuf(OpenRtbProtobuf.Site wrapped)` Wraps an existing Protobuf message.
`static Site.Protobuf`	`protobuf(Site<?> instance)` Returns a wrapped Protobuf message based on an instance of Site.
`static Site.Thrift`	`thrift(Site<?> instance)` Returns a wrapped Thrift struct based on an instance of Site.
`static Site.Thrift`	`thrift(SiteThrift 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
```
Site.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
String getId()
```
    Site ID on the exchange.
  - isDefaultId
```
boolean isDefaultId()
```
  - getName
```
String getName()
```
    Site name (may be masked at publisher’s request).
  - isDefaultName
```
boolean isDefaultName()
```
  - getDomain
```
String getDomain()
```
    Domain of the site, used for advertiser side blocking. For example, “foo.com”.
  - isDefaultDomain
```
boolean isDefaultDomain()
```
  - getCat
```
List<String> getCat()
```
    Array of IAB content categories for the overall site. See Table 6.1 Content Categories.
  - isDefaultCat
```
boolean isDefaultCat()
```
  - getSectioncat
```
List<String> getSectioncat()
```
    Array of IAB content categories for the current subsection of the site. See Table 6.1 Content Categories.
  - isDefaultSectioncat
```
boolean isDefaultSectioncat()
```
  - getPagecat
```
List<String> getPagecat()
```
    Array of IAB content categories for the current page. See Table 6.1 Content Categories.
  - isDefaultPagecat
```
boolean isDefaultPagecat()
```
  - getPage
```
String getPage()
```
    URL of the page where the impression will be shown.
  - isDefaultPage
```
boolean isDefaultPage()
```
  - getPrivacypolicy
```
int getPrivacypolicy()
```
    Specifies whether the site has a privacy policy. “1” means there is a policy. “0” means there is not.
  - isDefaultPrivacypolicy
```
boolean isDefaultPrivacypolicy()
```
  - getRef
```
String getRef()
```
    Referrer URL that caused navigation to the current page.
  - isDefaultRef
```
boolean isDefaultRef()
```
  - getSearch
```
String getSearch()
```
    Search string that caused navigation to the current page.
  - isDefaultSearch
```
boolean isDefaultSearch()
```
  - getPublisher
```
Publisher<?> getPublisher()
```
    See Publisher Object.
  - isDefaultPublisher
```
boolean isDefaultPublisher()
```
  - getContent
```
Content<?> getContent()
```
    See Content Object.
  - isDefaultContent
```
boolean isDefaultContent()
```
  - getKeywords
```
String getKeywords()
```
    List of keywords describing this site in a comma separated string.
  - isDefaultKeywords
```
boolean isDefaultKeywords()
```
  - getComparator
```
static Comparator<Site<?>> getComparator()
```
    Returns comparator instance for Site objects.
  - compareTo
```
default int compareTo(Site<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Site<?>>
  - newNativeImplBuilder
```
static Site.Builder<Site.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Site.Builder<Site.NativeImpl> newNativeImplBuilder(Site<?> other)
```
    Returns a POJO builder instance based on existing prototype Site.
  - nativeImpl
```
static Site.NativeImpl nativeImpl(Site<?> instance)
```
    Returns a POJO based on an instance of Site.
  - newAvroBuilder
```
static Site.Builder<SiteAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Site.Builder<SiteAvro> newAvroBuilder(SiteAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Site.Builder<SiteAvro> newAvroBuilder(SiteAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Site.Builder<SiteAvro> newAvroBuilder(Site<?> other)
```
    Returns new Avro builder instance based on existing prototype Site.
  - avro
```
static Site.Avro avro(Site<?> instance)
```
    Returns a wrapped Avro record based on an instance of Site.
  - avro
```
static Site.Avro avro(SiteAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<SiteAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Site.Builder<OpenRtbProtobuf.Site> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Site.Builder<OpenRtbProtobuf.Site> newProtobufBuilder(OpenRtbProtobuf.Site other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Site.Builder<OpenRtbProtobuf.Site> newProtobufBuilder(Site<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Site.
  - protobuf
```
static Site.Protobuf protobuf(Site<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Site.
  - protobuf
```
static Site.Protobuf protobuf(OpenRtbProtobuf.Site wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Site> 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 Site.Builder<SiteThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Site.Builder<SiteThrift> newThriftBuilder(SiteThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Site.Builder<SiteThrift> newThriftBuilder(Site<?> other)
```
    Returns new Thrift builder instance based on existing prototype Site.
  - thrift
```
static Site.Thrift thrift(Site<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Site.
  - thrift
```
static Site.Thrift thrift(SiteThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<SiteThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<SiteThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Site<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getName

isDefaultName

getDomain

isDefaultDomain

getCat

isDefaultCat

getSectioncat

isDefaultSectioncat

getPagecat

isDefaultPagecat

getPage

isDefaultPage

getPrivacypolicy

isDefaultPrivacypolicy

getRef

isDefaultRef

getSearch

isDefaultSearch

getPublisher

isDefaultPublisher

getContent

isDefaultContent

getKeywords

isDefaultKeywords

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