Package io.envoyproxy.envoy.service.rate_limit_quota.v3

Class RateLimitQuotaUsageReports.BucketQuotaUsage.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaUsageReports.BucketQuotaUsage.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder, java.lang.Cloneable

Enclosing class:

RateLimitQuotaUsageReports.BucketQuotaUsage

public static final class RateLimitQuotaUsageReports.BucketQuotaUsage.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaUsageReports.BucketQuotaUsage.Builder>
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

Field Summary

Fields

Modifier and Type	Field	Description
private int	bitField0_
private BucketId	bucketId_
private com.google.protobuf.SingleFieldBuilder<BucketId,BucketId.Builder,BucketIdOrBuilder>	bucketIdBuilder_
private long	numRequestsAllowed_
private long	numRequestsDenied_
private com.google.protobuf.Duration	timeElapsed_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration,com.google.protobuf.Duration.Builder,com.google.protobuf.DurationOrBuilder>	timeElapsedBuilder_

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()
private	Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

Method Summary

Modifier and Type	Method	Description
RateLimitQuotaUsageReports.BucketQuotaUsage	build()
RateLimitQuotaUsageReports.BucketQuotaUsage	buildPartial()
private void	buildPartial0(RateLimitQuotaUsageReports.BucketQuotaUsage result)
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	clear()
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	clearBucketId()	``BucketId`` for which request quota usage is reported.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	clearNumRequestsAllowed()	Requests the data plane has allowed through.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	clearNumRequestsDenied()	Requests throttled.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	clearTimeElapsed()	Time elapsed since the last report.
BucketId	getBucketId()	``BucketId`` for which request quota usage is reported.
BucketId.Builder	getBucketIdBuilder()	``BucketId`` for which request quota usage is reported.
private com.google.protobuf.SingleFieldBuilder<BucketId,BucketId.Builder,BucketIdOrBuilder>	getBucketIdFieldBuilder()	``BucketId`` for which request quota usage is reported.
BucketIdOrBuilder	getBucketIdOrBuilder()	``BucketId`` for which request quota usage is reported.
RateLimitQuotaUsageReports.BucketQuotaUsage	getDefaultInstanceForType()
static 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.Duration	getTimeElapsed()	Time elapsed since the last report.
com.google.protobuf.Duration.Builder	getTimeElapsedBuilder()	Time elapsed since the last report.
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration,com.google.protobuf.Duration.Builder,com.google.protobuf.DurationOrBuilder>	getTimeElapsedFieldBuilder()	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.
boolean	hasTimeElapsed()	Time elapsed since the last report.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
private void	maybeForceBuilderInitialization()
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	mergeBucketId(BucketId value)	``BucketId`` for which request quota usage is reported.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	mergeFrom(com.google.protobuf.Message other)
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	mergeFrom(RateLimitQuotaUsageReports.BucketQuotaUsage other)
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	mergeTimeElapsed(com.google.protobuf.Duration value)	Time elapsed since the last report.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	setBucketId(BucketId value)	``BucketId`` for which request quota usage is reported.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	setBucketId(BucketId.Builder builderForValue)	``BucketId`` for which request quota usage is reported.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	setNumRequestsAllowed(long value)	Requests the data plane has allowed through.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	setNumRequestsDenied(long value)	Requests throttled.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	setTimeElapsed(com.google.protobuf.Duration value)	Time elapsed since the last report.
RateLimitQuotaUsageReports.BucketQuotaUsage.Builder	setTimeElapsed(com.google.protobuf.Duration.Builder builderForValue)	Time elapsed since the last report.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

bitField0_

private int bitField0_

bucketId_

private BucketId bucketId_

bucketIdBuilder_

private com.google.protobuf.SingleFieldBuilder<BucketId,BucketId.Builder,BucketIdOrBuilder> bucketIdBuilder_

timeElapsed_

private com.google.protobuf.Duration timeElapsed_

timeElapsedBuilder_

private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration,com.google.protobuf.Duration.Builder,com.google.protobuf.DurationOrBuilder> timeElapsedBuilder_

numRequestsAllowed_

private long numRequestsAllowed_

numRequestsDenied_

private long numRequestsDenied_

Constructor Detail

Builder

private Builder()

Builder

private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaUsageReports.BucketQuotaUsage.Builder>

maybeForceBuilderInitialization

private void maybeForceBuilderInitialization()

clear

public RateLimitQuotaUsageReports.BucketQuotaUsage.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.GeneratedMessage.Builder<RateLimitQuotaUsageReports.BucketQuotaUsage.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.GeneratedMessage.Builder<RateLimitQuotaUsageReports.BucketQuotaUsage.Builder>

getDefaultInstanceForType

public RateLimitQuotaUsageReports.BucketQuotaUsage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RateLimitQuotaUsageReports.BucketQuotaUsage build()

Specified by:

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

Specified by:

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

buildPartial

public RateLimitQuotaUsageReports.BucketQuotaUsage buildPartial()

Specified by:

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

Specified by:

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

buildPartial0

private void buildPartial0(RateLimitQuotaUsageReports.BucketQuotaUsage result)

mergeFrom

public RateLimitQuotaUsageReports.BucketQuotaUsage.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<RateLimitQuotaUsageReports.BucketQuotaUsage.Builder>

mergeFrom

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder mergeFrom(RateLimitQuotaUsageReports.BucketQuotaUsage other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaUsageReports.BucketQuotaUsage.Builder>

mergeFrom

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws java.io.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<RateLimitQuotaUsageReports.BucketQuotaUsage.Builder>

Throws:

java.io.IOException

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.

setBucketId

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder setBucketId(BucketId value)

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

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

setBucketId

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder setBucketId(BucketId.Builder builderForValue)

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

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

mergeBucketId

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder mergeBucketId(BucketId value)

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

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

clearBucketId

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder clearBucketId()

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

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

getBucketIdBuilder

public BucketId.Builder getBucketIdBuilder()

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

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

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

getBucketIdFieldBuilder

private com.google.protobuf.SingleFieldBuilder<BucketId,BucketId.Builder,BucketIdOrBuilder> getBucketIdFieldBuilder()

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

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

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.

setTimeElapsed

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder setTimeElapsed(com.google.protobuf.Duration value)

 Time elapsed since the last report.
 

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

setTimeElapsed

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder setTimeElapsed(com.google.protobuf.Duration.Builder builderForValue)

 Time elapsed since the last report.
 

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

mergeTimeElapsed

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder mergeTimeElapsed(com.google.protobuf.Duration value)

 Time elapsed since the last report.
 

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

clearTimeElapsed

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder clearTimeElapsed()

 Time elapsed since the last report.
 

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

getTimeElapsedBuilder

public com.google.protobuf.Duration.Builder getTimeElapsedBuilder()

 Time elapsed since the last report.
 

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

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

getTimeElapsedFieldBuilder

private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration,com.google.protobuf.Duration.Builder,com.google.protobuf.DurationOrBuilder> getTimeElapsedFieldBuilder()

 Time elapsed since the last report.
 

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

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.

setNumRequestsAllowed

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder setNumRequestsAllowed(long value)

 Requests the data plane has allowed through.
 

uint64 num_requests_allowed = 3;

Parameters:

value - The numRequestsAllowed to set.

Returns:

This builder for chaining.

clearNumRequestsAllowed

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder clearNumRequestsAllowed()

 Requests the data plane has allowed through.
 

uint64 num_requests_allowed = 3;

Returns:

This builder for chaining.

getNumRequestsDenied

public long getNumRequestsDenied()

 Requests throttled.
 

uint64 num_requests_denied = 4;

Specified by:

getNumRequestsDenied in interface RateLimitQuotaUsageReports.BucketQuotaUsageOrBuilder

Returns:

The numRequestsDenied.

setNumRequestsDenied

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder setNumRequestsDenied(long value)

 Requests throttled.
 

uint64 num_requests_denied = 4;

Parameters:

value - The numRequestsDenied to set.

Returns:

This builder for chaining.

clearNumRequestsDenied

public RateLimitQuotaUsageReports.BucketQuotaUsage.Builder clearNumRequestsDenied()

 Requests throttled.
 

uint64 num_requests_denied = 4;

Returns:

This builder for chaining.