com.beeswax.bid

Class AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.beeswax.bid.AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap

All Implemented Interfaces:

AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCapOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

AdcandidateOuterClass.FrequencyCapsInfo

public static final class AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder 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`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURRENT_IMPRESSION_COUNT_FIELD_NUMBER
static int	DURATION_SECONDS_FIELD_NUMBER
static int	MAX_IMPRESSIONS_FIELD_NUMBER
static com.google.protobuf.Parser<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap>	PARSER Deprecated.

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getCurrentImpressionCount() Actual impression numbers served in the duration.
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	getDefaultInstance()
AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getDurationSeconds() The duration (in second) in which max_impressions should not be exceeded.
int	getMaxImpressions() Allowed number of impressions in the duration .
com.google.protobuf.Parser<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCurrentImpressionCount() Actual impression numbers served in the duration.
boolean	hasDurationSeconds() The duration (in second) in which max_impressions should not be exceeded.
int	hashCode()
boolean	hasMaxImpressions() Allowed number of impressions in the duration .
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder	newBuilder()
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder	newBuilder(AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap prototype)
AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder	newBuilderForType()
protected AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseDelimitedFrom(InputStream input)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(byte[] data)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(com.google.protobuf.ByteString data)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(com.google.protobuf.CodedInputStream input)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(InputStream input)
static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap>	parser()
AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MAX_IMPRESSIONS_FIELD_NUMBER

public static final int MAX_IMPRESSIONS_FIELD_NUMBER

See Also:

Constant Field Values

DURATION_SECONDS_FIELD_NUMBER

public static final int DURATION_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

CURRENT_IMPRESSION_COUNT_FIELD_NUMBER

public static final int CURRENT_IMPRESSION_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(com.google.protobuf.ByteString data)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(com.google.protobuf.ByteString data,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(byte[] data)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(byte[] data,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(InputStream input)
                                                                      throws IOException

Throws:

IOException

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(InputStream input,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseDelimitedFrom(InputStream input)
                                                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseDelimitedFrom(InputStream input,
                                                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                               throws IOException

Throws:

IOException

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(com.google.protobuf.CodedInputStream input)
                                                                      throws IOException

Throws:

IOException

parseFrom

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap parseFrom(com.google.protobuf.CodedInputStream input,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Throws:

IOException

newBuilderForType

public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder newBuilder()

newBuilder

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder newBuilder(AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap prototype)

toBuilder

public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap getDefaultInstance()

parser

public static com.google.protobuf.Parser<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap> parser()

getParserForType

public com.google.protobuf.Parser<AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AdcandidateOuterClass.FrequencyCapsInfo.FrequencyCap getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder