Extension.UserExtensions.Builder (Beeswax API 2018-03-13 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<BuilderType>
    - - com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>
      - com.beeswax.openrtb.Extension.UserExtensions.Builder

All Implemented Interfaces:

Extension.UserExtensionsOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<Extension.UserExtensions>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Extension.UserExtensions
```
public static final class Extension.UserExtensions.Builder
extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>
implements Extension.UserExtensionsOrBuilder
```
```
 Next available tag: 5
 
```
Protobuf type openrtb.UserExtensions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Extension.UserExtensions.Builder`	`addAllMatchedUserGroups(Iterable<? extends Extension.UserExtensions.MatchedUserGroups> values)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`<Type> Extension.UserExtensions.Builder`	`addExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,List<Type>> extension, Type value)`
`Extension.UserExtensions.Builder`	`addMatchedUserGroups(Extension.UserExtensions.MatchedUserGroups.Builder builderForValue)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`addMatchedUserGroups(Extension.UserExtensions.MatchedUserGroups value)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`addMatchedUserGroups(int index, Extension.UserExtensions.MatchedUserGroups.Builder builderForValue)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`addMatchedUserGroups(int index, Extension.UserExtensions.MatchedUserGroups value)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.MatchedUserGroups.Builder`	`addMatchedUserGroupsBuilder()` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.MatchedUserGroups.Builder`	`addMatchedUserGroupsBuilder(int index)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Extension.UserExtensions`	`build()`
`Extension.UserExtensions`	`buildPartial()`
`Extension.UserExtensions.Builder`	`clear()`
`Extension.UserExtensions.Builder`	`clearCookieAge()` Number of days since the user cookie has been dropped, for example, 10
`<Type> Extension.UserExtensions.Builder`	`clearExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,?> extension)`
`Extension.UserExtensions.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Extension.UserExtensions.Builder`	`clearMatchedUserGroups()` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Extension.UserExtensions.Builder`	`clearUserId()` This field identifies the user of the bid request.
`Extension.UserExtensions.Builder`	`clearUserIdType()` `optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;`
`Extension.UserExtensions.Builder`	`clone()`
`int`	`getCookieAge()` Number of days since the user cookie has been dropped, for example, 10
`Extension.UserExtensions`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`Extension.UserExtensions.MatchedUserGroups`	`getMatchedUserGroups(int index)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.MatchedUserGroups.Builder`	`getMatchedUserGroupsBuilder(int index)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`List<Extension.UserExtensions.MatchedUserGroups.Builder>`	`getMatchedUserGroupsBuilderList()` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`int`	`getMatchedUserGroupsCount()` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`List<Extension.UserExtensions.MatchedUserGroups>`	`getMatchedUserGroupsList()` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.MatchedUserGroupsOrBuilder`	`getMatchedUserGroupsOrBuilder(int index)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`List<? extends Extension.UserExtensions.MatchedUserGroupsOrBuilder>`	`getMatchedUserGroupsOrBuilderList()` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`String`	`getUserId()` This field identifies the user of the bid request.
`com.google.protobuf.ByteString`	`getUserIdBytes()` This field identifies the user of the bid request.
`OpenrtbCommon.Enums.BidRequest.User.UserIdType`	`getUserIdType()` `optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;`
`boolean`	`hasCookieAge()` Number of days since the user cookie has been dropped, for example, 10
`boolean`	`hasUserId()` This field identifies the user of the bid request.
`boolean`	`hasUserIdType()` `optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Extension.UserExtensions.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Extension.UserExtensions.Builder`	`mergeFrom(Extension.UserExtensions other)`
`Extension.UserExtensions.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Extension.UserExtensions.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Extension.UserExtensions.Builder`	`removeMatchedUserGroups(int index)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`setCookieAge(int value)` Number of days since the user cookie has been dropped, for example, 10
`<Type> Extension.UserExtensions.Builder`	`setExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,List<Type>> extension, int index, Type value)`
`<Type> Extension.UserExtensions.Builder`	`setExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,Type> extension, Type value)`
`Extension.UserExtensions.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Extension.UserExtensions.Builder`	`setMatchedUserGroups(int index, Extension.UserExtensions.MatchedUserGroups.Builder builderForValue)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`setMatchedUserGroups(int index, Extension.UserExtensions.MatchedUserGroups value)` `repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;`
`Extension.UserExtensions.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Extension.UserExtensions.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Extension.UserExtensions.Builder`	`setUserId(String value)` This field identifies the user of the bid request.
`Extension.UserExtensions.Builder`	`setUserIdBytes(com.google.protobuf.ByteString value)` This field identifies the user of the bid request.
`Extension.UserExtensions.Builder`	`setUserIdType(OpenrtbCommon.Enums.BidRequest.User.UserIdType value)` `optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder
addExtension, addExtension, clearExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, mergeExtensionFields, setExtension, setExtension, setExtension, setExtension

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedFieldBuilder, getUnknownFields, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

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

Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder
getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Extension.UserExtensions.Builder>

clear
```
public Extension.UserExtensions.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Extension.UserExtensions.Builder>

getDefaultInstanceForType
```
public Extension.UserExtensions getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<Extension.UserExtensions>

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Extension.UserExtensions build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Extension.UserExtensions buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Extension.UserExtensions.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Extension.UserExtensions.Builder>

setField

public Extension.UserExtensions.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

clearField
```
public Extension.UserExtensions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

clearOneof
```
public Extension.UserExtensions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Extension.UserExtensions.Builder>

setRepeatedField

public Extension.UserExtensions.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

addRepeatedField

public Extension.UserExtensions.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

setExtension

public <Type> Extension.UserExtensions.Builder setExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,Type> extension,
                                                            Type value)

Overrides:: setExtension in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

setExtension

public <Type> Extension.UserExtensions.Builder setExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,List<Type>> extension,
                                                            int index,
                                                            Type value)

Overrides:: setExtension in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

addExtension

public <Type> Extension.UserExtensions.Builder addExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,List<Type>> extension,
                                                            Type value)

Overrides:: addExtension in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

clearExtension

public <Type> Extension.UserExtensions.Builder clearExtension(com.google.protobuf.GeneratedMessage.GeneratedExtension<Extension.UserExtensions,?> extension)

Overrides:: clearExtension in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

mergeFrom
```
public Extension.UserExtensions.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Extension.UserExtensions.Builder>

mergeFrom

public Extension.UserExtensions.Builder mergeFrom(Extension.UserExtensions other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<Extension.UserExtensions,Extension.UserExtensions.Builder>

mergeFrom

public Extension.UserExtensions.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Specified by:: mergeFrom in interface com.google.protobuf.Message.Builder
Specified by:: mergeFrom in interface com.google.protobuf.MessageLite.Builder
Overrides:: mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Extension.UserExtensions.Builder>
Throws:: IOException

hasUserId

public boolean hasUserId()

 This field identifies the user of the bid request. It will be used
 for user segment lookup and frequency cap.
 For WEB request, its value is bito_id (user.id).
 For APP request, its value is the first field which has value
 in the following order:
 device.ifa -> device.dpidsha1 -> device.dpidmd5
 And the value is prefixed with the names in Enum.Bidrequest.User.UserIdType
 (Except bito_id - we still use bito as prefix)

optional string user_id = 1;

Specified by:: hasUserId in interface Extension.UserExtensionsOrBuilder

getUserId

public String getUserId()

 This field identifies the user of the bid request. It will be used
 for user segment lookup and frequency cap.
 For WEB request, its value is bito_id (user.id).
 For APP request, its value is the first field which has value
 in the following order:
 device.ifa -> device.dpidsha1 -> device.dpidmd5
 And the value is prefixed with the names in Enum.Bidrequest.User.UserIdType
 (Except bito_id - we still use bito as prefix)

optional string user_id = 1;

Specified by:: getUserId in interface Extension.UserExtensionsOrBuilder

getUserIdBytes

public com.google.protobuf.ByteString getUserIdBytes()

 This field identifies the user of the bid request. It will be used
 for user segment lookup and frequency cap.
 For WEB request, its value is bito_id (user.id).
 For APP request, its value is the first field which has value
 in the following order:
 device.ifa -> device.dpidsha1 -> device.dpidmd5
 And the value is prefixed with the names in Enum.Bidrequest.User.UserIdType
 (Except bito_id - we still use bito as prefix)

optional string user_id = 1;

Specified by:: getUserIdBytes in interface Extension.UserExtensionsOrBuilder

setUserId

public Extension.UserExtensions.Builder setUserId(String value)

 This field identifies the user of the bid request. It will be used
 for user segment lookup and frequency cap.
 For WEB request, its value is bito_id (user.id).
 For APP request, its value is the first field which has value
 in the following order:
 device.ifa -> device.dpidsha1 -> device.dpidmd5
 And the value is prefixed with the names in Enum.Bidrequest.User.UserIdType
 (Except bito_id - we still use bito as prefix)

optional string user_id = 1;

clearUserId

public Extension.UserExtensions.Builder clearUserId()

 This field identifies the user of the bid request. It will be used
 for user segment lookup and frequency cap.
 For WEB request, its value is bito_id (user.id).
 For APP request, its value is the first field which has value
 in the following order:
 device.ifa -> device.dpidsha1 -> device.dpidmd5
 And the value is prefixed with the names in Enum.Bidrequest.User.UserIdType
 (Except bito_id - we still use bito as prefix)

optional string user_id = 1;

setUserIdBytes

public Extension.UserExtensions.Builder setUserIdBytes(com.google.protobuf.ByteString value)

 This field identifies the user of the bid request. It will be used
 for user segment lookup and frequency cap.
 For WEB request, its value is bito_id (user.id).
 For APP request, its value is the first field which has value
 in the following order:
 device.ifa -> device.dpidsha1 -> device.dpidmd5
 And the value is prefixed with the names in Enum.Bidrequest.User.UserIdType
 (Except bito_id - we still use bito as prefix)

optional string user_id = 1;

hasUserIdType
```
public boolean hasUserIdType()
```
optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;

Specified by:

hasUserIdType in interface Extension.UserExtensionsOrBuilder

getUserIdType
```
public OpenrtbCommon.Enums.BidRequest.User.UserIdType getUserIdType()
```
optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;

Specified by:

getUserIdType in interface Extension.UserExtensionsOrBuilder

setUserIdType

public Extension.UserExtensions.Builder setUserIdType(OpenrtbCommon.Enums.BidRequest.User.UserIdType value)

optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;

clearUserIdType
```
public Extension.UserExtensions.Builder clearUserIdType()
```
optional .openrtb.Enums.BidRequest.User.UserIdType user_id_type = 2;

getMatchedUserGroupsList
```
public List<Extension.UserExtensions.MatchedUserGroups> getMatchedUserGroupsList()
```
repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;

Specified by:

getMatchedUserGroupsList in interface Extension.UserExtensionsOrBuilder

getMatchedUserGroupsCount
```
public int getMatchedUserGroupsCount()
```
repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;

Specified by:

getMatchedUserGroupsCount in interface Extension.UserExtensionsOrBuilder

getMatchedUserGroups
```
public Extension.UserExtensions.MatchedUserGroups getMatchedUserGroups(int index)
```
repeated .openrtb.UserExtensions.MatchedUserGroups matched_user_groups = 4;

Specified by:

getMatchedUserGroups in interface Extension.UserExtensionsOrBuilder