Package io.envoyproxy.envoy.service.ratelimit.v2

Class RateLimitResponse

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:

  • Field Details

    • OVERALL_CODE_FIELD_NUMBER

      public static final int OVERALL_CODE_FIELD_NUMBER
      See Also:

    • STATUSES_FIELD_NUMBER

      public static final int STATUSES_FIELD_NUMBER
      See Also:

    • HEADERS_FIELD_NUMBER

      public static final int HEADERS_FIELD_NUMBER
      See Also:

    • REQUEST_HEADERS_TO_ADD_FIELD_NUMBER

      public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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
      Returns:
      The enum numeric value on the wire for overallCode.

    • 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
      Returns:
      The overallCode.

    • getStatusesList

      public List<RateLimitResponse.DescriptorStatus> getStatusesList()
       A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
      repeated .envoy.service.ratelimit.v2.RateLimitResponse.DescriptorStatus statuses = 2;
      Specified by:
      getStatusesList in interface RateLimitResponseOrBuilder

    • getStatusesOrBuilderList

      public List<? extends RateLimitResponse.DescriptorStatusOrBuilder> getStatusesOrBuilderList()
       A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
      repeated .envoy.service.ratelimit.v2.RateLimitResponse.DescriptorStatus statuses = 2;
      Specified by:
      getStatusesOrBuilderList in interface RateLimitResponseOrBuilder

    • getStatusesCount

      public int getStatusesCount()
       A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
      repeated .envoy.service.ratelimit.v2.RateLimitResponse.DescriptorStatus statuses = 2;
      Specified by:
      getStatusesCount in interface RateLimitResponseOrBuilder

    • getStatuses

      public RateLimitResponse.DescriptorStatus getStatuses(int index)
       A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
      repeated .envoy.service.ratelimit.v2.RateLimitResponse.DescriptorStatus statuses = 2;
      Specified by:
      getStatuses in interface RateLimitResponseOrBuilder

    • getStatusesOrBuilder

      public RateLimitResponse.DescriptorStatusOrBuilder getStatusesOrBuilder(int index)
       A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
      repeated .envoy.service.ratelimit.v2.RateLimitResponse.DescriptorStatus statuses = 2;
      Specified by:
      getStatusesOrBuilder in interface RateLimitResponseOrBuilder

    • getHeadersList

      public List<HeaderValue> getHeadersList()
       A list of headers to add to the response
      repeated .envoy.api.v2.core.HeaderValue headers = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getHeadersList in interface RateLimitResponseOrBuilder

    • getHeadersOrBuilderList

      public 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) = { ... }
      Specified by:
      getHeadersOrBuilderList in interface RateLimitResponseOrBuilder

    • getHeadersCount

      public int getHeadersCount()
       A list of headers to add to the response
      repeated .envoy.api.v2.core.HeaderValue headers = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getHeadersCount in interface RateLimitResponseOrBuilder

    • getHeaders

      public 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) = { ... }
      Specified by:
      getHeaders in interface RateLimitResponseOrBuilder

    • getHeadersOrBuilder

      public 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) = { ... }
      Specified by:
      getHeadersOrBuilder in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddList

      public 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;
      Specified by:
      getRequestHeadersToAddList in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddOrBuilderList

      public 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;
      Specified by:
      getRequestHeadersToAddOrBuilderList in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddCount

      public int getRequestHeadersToAddCount()
       A list of headers to add to the request when forwarded
      repeated .envoy.api.v2.core.HeaderValue request_headers_to_add = 4;
      Specified by:
      getRequestHeadersToAddCount in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAdd

      public 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;
      Specified by:
      getRequestHeadersToAdd in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddOrBuilder

      public 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;
      Specified by:
      getRequestHeadersToAddOrBuilder in interface RateLimitResponseOrBuilder

    • 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 RateLimitResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimitResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimitResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimitResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimitResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimitResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimitResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimitResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RateLimitResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RateLimitResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimitResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimitResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RateLimitResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RateLimitResponse.Builder newBuilder()

    • newBuilder

      public static RateLimitResponse.Builder newBuilder(RateLimitResponse prototype)

    • toBuilder

      public RateLimitResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RateLimitResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RateLimitResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RateLimitResponse> 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 RateLimitResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder