Segment (anoa-tests 3.1.2 API)

All Superinterfaces:

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

All Known Implementing Classes:

Segment.Avro, Segment.NativeImpl, Segment.Protobuf, Segment.Thrift
```
public interface Segment<T>
extends Supplier<T>, Comparable<Segment<?>>, Serializable
```
3.3.14 Segment Object The data and segment objects together allow data about the user to be passed to bidders in the bid request. Segment objects convey specific units of information from the provider identified in the parent data object. The segment 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.

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Segment.Avro`	`avro(Segment<?> instance)` Returns a wrapped Avro record based on an instance of Segment.
`static Segment.Avro`	`avro(SegmentAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Segment<?> other)`
`T`	`get()` Returns underlying object.
`static Class<SegmentAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`static Comparator<Segment<?>>`	`getComparator()` Returns comparator instance for Segment objects.
`String`	`getId()` ID of a data provider’s segment applicable to the user.
`String`	`getName()` Name of a data provider’s segment applicable to the user.
`static Class<OpenRtbProtobuf.Segment>`	`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<SegmentThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<SegmentThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`String`	`getValue()` String representing the value of the segment.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultId()`
`boolean`	`isDefaultName()`
`boolean`	`isDefaultValue()`
`static Segment.NativeImpl`	`nativeImpl(Segment<?> instance)` Returns a POJO based on an instance of Segment.
`static Segment.Builder<SegmentAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Segment.Builder<SegmentAvro>`	`newAvroBuilder(Segment<?> other)` Returns new Avro builder instance based on existing prototype Segment.
`static Segment.Builder<SegmentAvro>`	`newAvroBuilder(SegmentAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Segment.Builder<SegmentAvro>`	`newAvroBuilder(SegmentAvro other)` Returns new Avro builder instance based on existing prototype.
`Segment.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Segment.Builder<Segment.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Segment.Builder<Segment.NativeImpl>`	`newNativeImplBuilder(Segment<?> other)` Returns a POJO builder instance based on existing prototype Segment.
`static Segment.Builder<OpenRtbProtobuf.Segment>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Segment.Builder<OpenRtbProtobuf.Segment>`	`newProtobufBuilder(OpenRtbProtobuf.Segment other)` Returns new Protobuf builder instance based on existing prototype.
`static Segment.Builder<OpenRtbProtobuf.Segment>`	`newProtobufBuilder(Segment<?> other)` Returns new Protobuf builder instance based on existing prototype Segment.
`static Segment.Builder<SegmentThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Segment.Builder<SegmentThrift>`	`newThriftBuilder(Segment<?> other)` Returns new Thrift builder instance based on existing prototype Segment.
`static Segment.Builder<SegmentThrift>`	`newThriftBuilder(SegmentThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Segment.Protobuf`	`protobuf(OpenRtbProtobuf.Segment wrapped)` Wraps an existing Protobuf message.
`static Segment.Protobuf`	`protobuf(Segment<?> instance)` Returns a wrapped Protobuf message based on an instance of Segment.
`static Segment.Thrift`	`thrift(Segment<?> instance)` Returns a wrapped Thrift struct based on an instance of Segment.
`static Segment.Thrift`	`thrift(SegmentThrift 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
```
Segment.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
String getId()
```
    ID of a data provider’s segment applicable to the user.
  - isDefaultId
```
boolean isDefaultId()
```
  - getName
```
String getName()
```
    Name of a data provider’s segment applicable to the user.
  - isDefaultName
```
boolean isDefaultName()
```
  - getValue
```
String getValue()
```
    String representing the value of the segment. The method for transmitting this data should be negotiated offline with the data provider. For example for gender, “male”, or “female”, for age, “30-40”).
  - isDefaultValue
```
boolean isDefaultValue()
```
  - getComparator
```
static Comparator<Segment<?>> getComparator()
```
    Returns comparator instance for Segment objects.
  - compareTo
```
default int compareTo(Segment<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Segment<?>>
  - newNativeImplBuilder
```
static Segment.Builder<Segment.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Segment.Builder<Segment.NativeImpl> newNativeImplBuilder(Segment<?> other)
```
    Returns a POJO builder instance based on existing prototype Segment.
  - nativeImpl
```
static Segment.NativeImpl nativeImpl(Segment<?> instance)
```
    Returns a POJO based on an instance of Segment.
  - newAvroBuilder
```
static Segment.Builder<SegmentAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Segment.Builder<SegmentAvro> newAvroBuilder(SegmentAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Segment.Builder<SegmentAvro> newAvroBuilder(SegmentAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Segment.Builder<SegmentAvro> newAvroBuilder(Segment<?> other)
```
    Returns new Avro builder instance based on existing prototype Segment.
  - avro
```
static Segment.Avro avro(Segment<?> instance)
```
    Returns a wrapped Avro record based on an instance of Segment.
  - avro
```
static Segment.Avro avro(SegmentAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<SegmentAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Segment.Builder<OpenRtbProtobuf.Segment> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Segment.Builder<OpenRtbProtobuf.Segment> newProtobufBuilder(OpenRtbProtobuf.Segment other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Segment.Builder<OpenRtbProtobuf.Segment> newProtobufBuilder(Segment<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Segment.
  - protobuf
```
static Segment.Protobuf protobuf(Segment<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Segment.
  - protobuf
```
static Segment.Protobuf protobuf(OpenRtbProtobuf.Segment wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Segment> 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 Segment.Builder<SegmentThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Segment.Builder<SegmentThrift> newThriftBuilder(SegmentThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Segment.Builder<SegmentThrift> newThriftBuilder(Segment<?> other)
```
    Returns new Thrift builder instance based on existing prototype Segment.
  - thrift
```
static Segment.Thrift thrift(Segment<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Segment.
  - thrift
```
static Segment.Thrift thrift(SegmentThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<SegmentThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<SegmentThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Segment<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getName

isDefaultName

getValue

isDefaultValue

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