AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder (Beeswax API 2017-02-13 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
    - - com.beeswax.bid.AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder

All Implemented Interfaces:: AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap

public static final class AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
implements AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder

 FrequencyCap contains the frequency constraints for a given user to not
 view the ad more than `max_impressions` times within a duration of
 `duration_seconds`, and the actual impression counts within the duration
 for the user as in `current_impression_count`.
 `max_impressions` and `duration_seconds` are defined using Buzz API, and
 `current_impression_count` is populated real-time per request.
 E.g. If a line item specifies hourly frequency cap
 constraints of 10 impression/user, and it has had impressions for the
 past hour, the value will be
 {max_impressions = 10, duration_secs = 3600, current_impression_count = 2}.
 Next Id: 4

Protobuf type bid.FrequencyCapsInfo.FrequencyCap

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap`	`build()`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap`	`buildPartial()`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`clear()`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`clearCurrentImpressionCount()` Actual impression numbers served in the duration.
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`clearDurationSeconds()` The duration (in second) in which max_impressions should not be exceeded.
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`clearMaxImpressions()` Allowed number of impressions in the duration .
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`clone()`
`int`	`getCurrentImpressionCount()` Actual impression numbers served in the duration.
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`int`	`getDurationSeconds()` The duration (in second) in which max_impressions should not be exceeded.
`int`	`getMaxImpressions()` Allowed number of impressions in the duration .
`boolean`	`hasCurrentImpressionCount()` Actual impression numbers served in the duration.
`boolean`	`hasDurationSeconds()` The duration (in second) in which max_impressions should not be exceeded.
`boolean`	`hasMaxImpressions()` Allowed number of impressions in the duration .
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`mergeFrom(AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap other)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`setCurrentImpressionCount(int value)` Actual impression numbers served in the duration.
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`setDurationSeconds(int value)` The duration (in second) in which max_impressions should not be exceeded.
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`setMaxImpressions(int value)` Allowed number of impressions in the duration .
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

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, 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.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<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - clear
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - getDefaultInstanceForType
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - setField
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - clearField
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - clearOneof
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - setRepeatedField
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - addRepeatedField
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - mergeFrom
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - mergeFrom
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder mergeFrom(AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - mergeFrom
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.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<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
    
    Throws:
    
    IOException
  - hasMaxImpressions
```
public boolean hasMaxImpressions()
```
```
 Allowed number of impressions in the duration .
 
```
    optional uint32 max_impressions = 1;
    Specified by:
    
    hasMaxImpressions in interface AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder
  - getMaxImpressions
```
public int getMaxImpressions()
```
```
 Allowed number of impressions in the duration .
 
```
    optional uint32 max_impressions = 1;
    Specified by:
    
    getMaxImpressions in interface AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder
  - setMaxImpressions
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder setMaxImpressions(int value)
```
```
 Allowed number of impressions in the duration .
 
```
    optional uint32 max_impressions = 1;
  - clearMaxImpressions
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder clearMaxImpressions()
```
```
 Allowed number of impressions in the duration .
 
```
    optional uint32 max_impressions = 1;
  - hasDurationSeconds
```
public boolean hasDurationSeconds()
```
```
 The duration (in second) in which max_impressions should not be exceeded.
 
```
    optional uint32 duration_seconds = 2;
    Specified by:
    
    hasDurationSeconds in interface AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder
  - getDurationSeconds
```
public int getDurationSeconds()
```
```
 The duration (in second) in which max_impressions should not be exceeded.
 
```
    optional uint32 duration_seconds = 2;
    Specified by:
    
    getDurationSeconds in interface AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder
  - setDurationSeconds
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder setDurationSeconds(int value)
```
```
 The duration (in second) in which max_impressions should not be exceeded.
 
```
    optional uint32 duration_seconds = 2;
  - clearDurationSeconds
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder clearDurationSeconds()
```
```
 The duration (in second) in which max_impressions should not be exceeded.
 
```
    optional uint32 duration_seconds = 2;
  - hasCurrentImpressionCount
```
public boolean hasCurrentImpressionCount()
```
```
 Actual impression numbers served in the duration.
 
```
    optional uint32 current_impression_count = 3;
    Specified by:
    
    hasCurrentImpressionCount in interface AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder
  - getCurrentImpressionCount
```
public int getCurrentImpressionCount()
```
```
 Actual impression numbers served in the duration.
 
```
    optional uint32 current_impression_count = 3;
    Specified by:
    
    getCurrentImpressionCount in interface AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder
  - setCurrentImpressionCount
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder setCurrentImpressionCount(int value)
```
```
 Actual impression numbers served in the duration.
 
```
    optional uint32 current_impression_count = 3;
  - clearCurrentImpressionCount
```
public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder clearCurrentImpressionCount()
```
```
 Actual impression numbers served in the duration.
 
```
    optional uint32 current_impression_count = 3;
  - setUnknownFields
```
public final AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>
  - mergeUnknownFields
```
public final AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder>

Class AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasMaxImpressions

getMaxImpressions

setMaxImpressions

clearMaxImpressions

hasDurationSeconds

getDurationSeconds

setDurationSeconds

clearDurationSeconds

hasCurrentImpressionCount

getCurrentImpressionCount

setCurrentImpressionCount

clearCurrentImpressionCount

setUnknownFields

mergeUnknownFields