RateLimitResponse (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.service.ratelimit.v2.RateLimitResponse

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitResponseOrBuilder, Serializable
```
public final class RateLimitResponse
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitResponseOrBuilder
```
```
 A response from a ShouldRateLimit call.
 
```
Protobuf type envoy.service.ratelimit.v2.RateLimitResponse
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RateLimitResponse.Builder` A response from a ShouldRateLimit call.
`static class`	`RateLimitResponse.Code` Protobuf enum `envoy.service.ratelimit.v2.RateLimitResponse.Code`
`static class`	`RateLimitResponse.DescriptorStatus` Protobuf type `envoy.service.ratelimit.v2.RateLimitResponse.DescriptorStatus`
`static interface`	`RateLimitResponse.DescriptorStatusOrBuilder`
`static class`	`RateLimitResponse.RateLimit` Defines an actual rate limit in terms of requests per unit of time and the unit itself.
`static interface`	`RateLimitResponse.RateLimitOrBuilder`

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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`HEADERS_FIELD_NUMBER`
`static int`	`OVERALL_CODE_FIELD_NUMBER`
`static int`	`REQUEST_HEADERS_TO_ADD_FIELD_NUMBER`
`static int`	`STATUSES_FIELD_NUMBER`

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static RateLimitResponse`	`getDefaultInstance()`
`RateLimitResponse`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`HeaderValue`	`getHeaders(int index)` A list of headers to add to the response `repeated .envoy.api.v2.core.HeaderValue headers = 3 [(.udpa.annotations.field_migrate) = { ... }`
`int`	`getHeadersCount()` A list of headers to add to the response `repeated .envoy.api.v2.core.HeaderValue headers = 3 [(.udpa.annotations.field_migrate) = { ... }`
`List<HeaderValue>`	`getHeadersList()` A list of headers to add to the response `repeated .envoy.api.v2.core.HeaderValue headers = 3 [(.udpa.annotations.field_migrate) = { ... }`
`HeaderValueOrBuilder`	`getHeadersOrBuilder(int index)` A list of headers to add to the response `repeated .envoy.api.v2.core.HeaderValue headers = 3 [(.udpa.annotations.field_migrate) = { ... }`
`List<? extends HeaderValueOrBuilder>`	`getHeadersOrBuilderList()` A list of headers to add to the response `repeated .envoy.api.v2.core.HeaderValue headers = 3 [(.udpa.annotations.field_migrate) = { ... }`
`RateLimitResponse.Code`	`getOverallCode()` The overall response code which takes into account all of the descriptors that were passed in the RateLimitRequest message.
`int`	`getOverallCodeValue()` The overall response code which takes into account all of the descriptors that were passed in the RateLimitRequest message.
`com.google.protobuf.Parser<RateLimitResponse>`	`getParserForType()`
`HeaderValue`	`getRequestHeadersToAdd(int index)` A list of headers to add to the request when forwarded `repeated .envoy.api.v2.core.HeaderValue request_headers_to_add = 4;`
`int`	`getRequestHeadersToAddCount()` A list of headers to add to the request when forwarded `repeated .envoy.api.v2.core.HeaderValue request_headers_to_add = 4;`
`List<HeaderValue>`	`getRequestHeadersToAddList()` A list of headers to add to the request when forwarded `repeated .envoy.api.v2.core.HeaderValue request_headers_to_add = 4;`
`HeaderValueOrBuilder`	`getRequestHeadersToAddOrBuilder(int index)` A list of headers to add to the request when forwarded `repeated .envoy.api.v2.core.HeaderValue request_headers_to_add = 4;`
`List<? extends HeaderValueOrBuilder>`	`getRequestHeadersToAddOrBuilderList()` A list of headers to add to the request when forwarded `repeated .envoy.api.v2.core.HeaderValue request_headers_to_add = 4;`
`int`	`getSerializedSize()`
`RateLimitResponse.DescriptorStatus`	`getStatuses(int index)` A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest.
`int`	`getStatusesCount()` A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest.
`List<RateLimitResponse.DescriptorStatus>`	`getStatusesList()` A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest.
`RateLimitResponse.DescriptorStatusOrBuilder`	`getStatusesOrBuilder(int index)` A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest.
`List<? extends RateLimitResponse.DescriptorStatusOrBuilder>`	`getStatusesOrBuilderList()` A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static RateLimitResponse.Builder`	`newBuilder()`
`static RateLimitResponse.Builder`	`newBuilder(RateLimitResponse prototype)`
`RateLimitResponse.Builder`	`newBuilderForType()`
`protected RateLimitResponse.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static RateLimitResponse`	`parseDelimitedFrom(InputStream input)`
`static RateLimitResponse`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RateLimitResponse`	`parseFrom(byte[] data)`
`static RateLimitResponse`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RateLimitResponse`	`parseFrom(ByteBuffer data)`
`static RateLimitResponse`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RateLimitResponse`	`parseFrom(com.google.protobuf.ByteString data)`
`static RateLimitResponse`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RateLimitResponse`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RateLimitResponse`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RateLimitResponse`	`parseFrom(InputStream input)`
`static RateLimitResponse`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RateLimitResponse>`	`parser()`
`RateLimitResponse.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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
- OVERALL_CODE_FIELD_NUMBER
```
public static final int OVERALL_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATUSES_FIELD_NUMBER
```
public static final int STATUSES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
```
public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

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

getOverallCodeValue

public int getOverallCodeValue()

 The overall response code which takes into account all of the descriptors that were passed
 in the RateLimitRequest message.

.envoy.service.ratelimit.v2.RateLimitResponse.Code overall_code = 1;

Specified by:: getOverallCodeValue in interface RateLimitResponseOrBuilder

getOverallCode

public RateLimitResponse.Code getOverallCode()

 The overall response code which takes into account all of the descriptors that were passed
 in the RateLimitRequest message.

.envoy.service.ratelimit.v2.RateLimitResponse.Code overall_code = 1;

Specified by:: getOverallCode in interface RateLimitResponseOrBuilder