Class RateLimitQuotaUsageReports.BucketQuotaUsage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

io.envoyproxy.envoy.service.rate_limit_quota.v3.RateLimitQuotaUsageReports.BucketQuotaUsage

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder, Serializable

Enclosing class:

RateLimitQuotaUsageReports

public static final class RateLimitQuotaUsageReports.BucketQuotaUsage
extends com.google.protobuf.GeneratedMessage
implements RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

The usage report for a bucket.

.. note::
Note that the first report sent for a ``BucketId`` indicates to the RLQS server that
the RLQS client is subscribing for the future assignments for this ``BucketId``.

Protobuf type envoy.service.rate_limit_quota.v3.RateLimitQuotaUsageReports.BucketQuotaUsage

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	The usage report for a bucket.

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, 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

Fields

Modifier and Type	Field	Description
private int	bitField0_
static final int	BUCKET_ID_FIELD_NUMBER
private BucketId	bucketId_
private static final RateLimitQuotaUsageReports.BucketQuotaUsage	DEFAULT_INSTANCE
private byte	memoizedIsInitialized
static final int	NUM_REQUESTS_ALLOWED_FIELD_NUMBER
static final int	NUM_REQUESTS_DENIED_FIELD_NUMBER
private long	numRequestsAllowed_
private long	numRequestsDenied_
private static final com.google.protobuf.Parser<RateLimitQuotaUsageReports.BucketQuotaUsage>	PARSER
private static final long	serialVersionUID
static final int	TIME_ELAPSED_FIELD_NUMBER
private com.google.protobuf.Duration	timeElapsed_

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BucketQuotaUsage()
private	BucketQuotaUsage(com.google.protobuf.GeneratedMessage.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
BucketId	getBucketId()	``BucketId`` for which request quota usage is reported.
BucketIdOrBuilder	getBucketIdOrBuilder()	``BucketId`` for which request quota usage is reported.
static RateLimitQuotaUsageReports.BucketQuotaUsage	getDefaultInstance()
RateLimitQuotaUsageReports.BucketQuotaUsage	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
long	getNumRequestsAllowed()	Requests the data plane has allowed through.
long	getNumRequestsDenied()	Requests throttled.
com.google.protobuf.Parser<RateLimitQuotaUsageReports.BucketQuotaUsage>	getParserForType()
int	getSerializedSize()
com.google.protobuf.Duration	getTimeElapsed()	Time elapsed since the last report.
com.google.protobuf.DurationOrBuilder	getTimeElapsedOrBuilder()	Time elapsed since the last report.
boolean	hasBucketId()	``BucketId`` for which request quota usage is reported.
int	hashCode()
boolean	hasTimeElapsed()	Time elapsed since the last report.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	newBuilder()
static RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	newBuilder(RateLimitQuotaUsageReports.BucketQuotaUsage prototype)
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	newBuilderForType()
protected RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseDelimitedFrom(InputStream input)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(byte[] data)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(com.google.protobuf.ByteString data)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(InputStream input)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(ByteBuffer data)
static RateLimitQuotaUsageReports.BucketQuotaUsage	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimitQuotaUsageReports.BucketQuotaUsage>	parser()
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

bitField0_

private int bitField0_

BUCKET_ID_FIELD_NUMBER

public static final int BUCKET_ID_FIELD_NUMBER

See Also:

• Constant Field Values

bucketId_

private BucketId bucketId_

TIME_ELAPSED_FIELD_NUMBER

public static final int TIME_ELAPSED_FIELD_NUMBER

See Also:

• Constant Field Values

timeElapsed_

private com.google.protobuf.Duration timeElapsed_

NUM_REQUESTS_ALLOWED_FIELD_NUMBER

public static final int NUM_REQUESTS_ALLOWED_FIELD_NUMBER

See Also:

• Constant Field Values

numRequestsAllowed_

private long numRequestsAllowed_

NUM_REQUESTS_DENIED_FIELD_NUMBER

public static final int NUM_REQUESTS_DENIED_FIELD_NUMBER

See Also:

• Constant Field Values

numRequestsDenied_

private long numRequestsDenied_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final RateLimitQuotaUsageReports.BucketQuotaUsage DEFAULT_INSTANCE

PARSER

private static final com.google.protobuf.Parser<RateLimitQuotaUsageReports.BucketQuotaUsage> PARSER

Constructor Details

BucketQuotaUsage

private BucketQuotaUsage(com.google.protobuf.GeneratedMessage.Builder<?> builder)

BucketQuotaUsage

private BucketQuotaUsage()

Method Details

getDescriptor

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

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasBucketId

public boolean hasBucketId()

``BucketId`` for which request quota usage is reported.

.envoy.service.rate_limit_quota.v3.BucketId bucket_id = 1 [(.validate.rules) = { ... }

Specified by:

hasBucketId in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

Returns:

Whether the bucketId field is set.

getBucketId

public BucketId getBucketId()

``BucketId`` for which request quota usage is reported.

.envoy.service.rate_limit_quota.v3.BucketId bucket_id = 1 [(.validate.rules) = { ... }

Specified by:

getBucketId in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

Returns:

The bucketId.

getBucketIdOrBuilder

public BucketIdOrBuilder getBucketIdOrBuilder()

``BucketId`` for which request quota usage is reported.

.envoy.service.rate_limit_quota.v3.BucketId bucket_id = 1 [(.validate.rules) = { ... }

Specified by:

getBucketIdOrBuilder in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

hasTimeElapsed

public boolean hasTimeElapsed()

Time elapsed since the last report.

.google.protobuf.Duration time_elapsed = 2 [(.validate.rules) = { ... }

Specified by:

hasTimeElapsed in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

Returns:

Whether the timeElapsed field is set.

getTimeElapsed

public com.google.protobuf.Duration getTimeElapsed()

Time elapsed since the last report.

.google.protobuf.Duration time_elapsed = 2 [(.validate.rules) = { ... }

Specified by:

getTimeElapsed in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

Returns:

The timeElapsed.

getTimeElapsedOrBuilder

public com.google.protobuf.DurationOrBuilder getTimeElapsedOrBuilder()

Time elapsed since the last report.

.google.protobuf.Duration time_elapsed = 2 [(.validate.rules) = { ... }

Specified by:

getTimeElapsedOrBuilder in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

getNumRequestsAllowed

public long getNumRequestsAllowed()

Requests the data plane has allowed through.

uint64 num_requests_allowed = 3;

Specified by:

getNumRequestsAllowed in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

Returns:

The numRequestsAllowed.

getNumRequestsDenied

public long getNumRequestsDenied()

Requests throttled.

uint64 num_requests_denied = 4;

Specified by:

getNumRequestsDenied in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

Returns:

The numRequestsDenied.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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 RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(ByteBuffer data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(com.google.protobuf.ByteString data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(byte[] data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseDelimitedFrom(InputStream input)
                                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Throws:

IOException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(com.google.protobuf.CodedInputStream input)
                                                             throws IOException

Throws:

IOException

parseFrom

public static RateLimitQuotaUsageReports.BucketQuotaUsage parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

newBuilderForType

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RateLimitQuotaUsageReports.BucketQuotaUsage.Builder newBuilder()

newBuilder

public static RateLimitQuotaUsageReports.BucketQuotaUsage.Builder newBuilder(RateLimitQuotaUsageReports.BucketQuotaUsage prototype)

toBuilder

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RateLimitQuotaUsageReports.BucketQuotaUsage.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static RateLimitQuotaUsageReports.BucketQuotaUsage getDefaultInstance()

parser

public static com.google.protobuf.Parser<RateLimitQuotaUsageReports.BucketQuotaUsage> parser()

getParserForType

public com.google.protobuf.Parser<RateLimitQuotaUsageReports.BucketQuotaUsage> 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.GeneratedMessage

getDefaultInstanceForType

public RateLimitQuotaUsageReports.BucketQuotaUsage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder