Package io.envoyproxy.envoy.type.v3
Class TokenBucket
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.type.v3.TokenBucket
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,TokenBucketOrBuilder
,Serializable
public final class TokenBucket
extends com.google.protobuf.GeneratedMessage
implements TokenBucketOrBuilder
Configures a token bucket, typically used for rate limiting.Protobuf type
envoy.type.v3.TokenBucket
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Configures a token bucket, typically used for rate limiting.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final TokenBucket
static final int
private com.google.protobuf.Duration
static final int
private int
private byte
private static final com.google.protobuf.Parser
<TokenBucket> private static final long
static final int
private com.google.protobuf.UInt32Value
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
TokenBucket
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static TokenBucket
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Duration
The fill interval that tokens are added to the bucket.com.google.protobuf.DurationOrBuilder
The fill interval that tokens are added to the bucket.int
The maximum tokens that the bucket can hold.com.google.protobuf.Parser
<TokenBucket> int
com.google.protobuf.UInt32Value
The number of tokens added to the bucket during each fill interval.com.google.protobuf.UInt32ValueOrBuilder
The number of tokens added to the bucket during each fill interval.boolean
The fill interval that tokens are added to the bucket.int
hashCode()
boolean
The number of tokens added to the bucket during each fill interval.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static TokenBucket.Builder
static TokenBucket.Builder
newBuilder
(TokenBucket prototype) protected TokenBucket.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static TokenBucket
parseDelimitedFrom
(InputStream input) static TokenBucket
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenBucket
parseFrom
(byte[] data) static TokenBucket
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenBucket
parseFrom
(com.google.protobuf.ByteString data) static TokenBucket
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenBucket
parseFrom
(com.google.protobuf.CodedInputStream input) static TokenBucket
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenBucket
parseFrom
(InputStream input) static TokenBucket
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenBucket
parseFrom
(ByteBuffer data) static TokenBucket
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<TokenBucket> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
MAX_TOKENS_FIELD_NUMBER
public static final int MAX_TOKENS_FIELD_NUMBER- See Also:
-
maxTokens_
private int maxTokens_ -
TOKENS_PER_FILL_FIELD_NUMBER
public static final int TOKENS_PER_FILL_FIELD_NUMBER- See Also:
-
tokensPerFill_
private com.google.protobuf.UInt32Value tokensPerFill_ -
FILL_INTERVAL_FIELD_NUMBER
public static final int FILL_INTERVAL_FIELD_NUMBER- See Also:
-
fillInterval_
private com.google.protobuf.Duration fillInterval_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
TokenBucket
private TokenBucket(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
TokenBucket
private TokenBucket()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getMaxTokens
public int getMaxTokens()The maximum tokens that the bucket can hold. This is also the number of tokens that the bucket initially contains.
uint32 max_tokens = 1 [(.validate.rules) = { ... }
- Specified by:
getMaxTokens
in interfaceTokenBucketOrBuilder
- Returns:
- The maxTokens.
-
hasTokensPerFill
public boolean hasTokensPerFill()The number of tokens added to the bucket during each fill interval. If not specified, defaults to a single token.
.google.protobuf.UInt32Value tokens_per_fill = 2 [(.validate.rules) = { ... }
- Specified by:
hasTokensPerFill
in interfaceTokenBucketOrBuilder
- Returns:
- Whether the tokensPerFill field is set.
-
getTokensPerFill
public com.google.protobuf.UInt32Value getTokensPerFill()The number of tokens added to the bucket during each fill interval. If not specified, defaults to a single token.
.google.protobuf.UInt32Value tokens_per_fill = 2 [(.validate.rules) = { ... }
- Specified by:
getTokensPerFill
in interfaceTokenBucketOrBuilder
- Returns:
- The tokensPerFill.
-
getTokensPerFillOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getTokensPerFillOrBuilder()The number of tokens added to the bucket during each fill interval. If not specified, defaults to a single token.
.google.protobuf.UInt32Value tokens_per_fill = 2 [(.validate.rules) = { ... }
- Specified by:
getTokensPerFillOrBuilder
in interfaceTokenBucketOrBuilder
-
hasFillInterval
public boolean hasFillInterval()The fill interval that tokens are added to the bucket. During each fill interval ``tokens_per_fill`` are added to the bucket. The bucket will never contain more than ``max_tokens`` tokens.
.google.protobuf.Duration fill_interval = 3 [(.validate.rules) = { ... }
- Specified by:
hasFillInterval
in interfaceTokenBucketOrBuilder
- Returns:
- Whether the fillInterval field is set.
-
getFillInterval
public com.google.protobuf.Duration getFillInterval()The fill interval that tokens are added to the bucket. During each fill interval ``tokens_per_fill`` are added to the bucket. The bucket will never contain more than ``max_tokens`` tokens.
.google.protobuf.Duration fill_interval = 3 [(.validate.rules) = { ... }
- Specified by:
getFillInterval
in interfaceTokenBucketOrBuilder
- Returns:
- The fillInterval.
-
getFillIntervalOrBuilder
public com.google.protobuf.DurationOrBuilder getFillIntervalOrBuilder()The fill interval that tokens are added to the bucket. During each fill interval ``tokens_per_fill`` are added to the bucket. The bucket will never contain more than ``max_tokens`` tokens.
.google.protobuf.Duration fill_interval = 3 [(.validate.rules) = { ... }
- Specified by:
getFillIntervalOrBuilder
in interfaceTokenBucketOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static TokenBucket parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenBucket parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenBucket parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenBucket parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenBucket parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenBucket parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TokenBucket parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static TokenBucket parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TokenBucket parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TokenBucket.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-