Interface RateLimit.Action.RequestHeadersOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RateLimit.Action.RequestHeaders, RateLimit.Action.RequestHeaders.Builder
Enclosing class:
RateLimit.Action

public static interface RateLimit.Action.RequestHeadersOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    The key to use in the descriptor entry.
    com.google.protobuf.ByteString
    The key to use in the descriptor entry.
    The header name to be queried from the request headers.
    com.google.protobuf.ByteString
    The header name to be queried from the request headers.
    boolean
    If set to true, Envoy skips the descriptor while calling rate limiting service when header is not present in the request.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getHeaderName

      String getHeaderName()
       The header name to be queried from the request headers. The header’s
       value is used to populate the value of the descriptor entry for the
       descriptor_key.
       
      string header_name = 1 [(.validate.rules) = { ... }
      Returns:
      The headerName.
    • getHeaderNameBytes

      com.google.protobuf.ByteString getHeaderNameBytes()
       The header name to be queried from the request headers. The header’s
       value is used to populate the value of the descriptor entry for the
       descriptor_key.
       
      string header_name = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for headerName.
    • getDescriptorKey

      String getDescriptorKey()
       The key to use in the descriptor entry.
       
      string descriptor_key = 2 [(.validate.rules) = { ... }
      Returns:
      The descriptorKey.
    • getDescriptorKeyBytes

      com.google.protobuf.ByteString getDescriptorKeyBytes()
       The key to use in the descriptor entry.
       
      string descriptor_key = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for descriptorKey.
    • getSkipIfAbsent

      boolean getSkipIfAbsent()
       If set to true, Envoy skips the descriptor while calling rate limiting service
       when header is not present in the request. By default it skips calling the
       rate limiting service if this header is not present in the request.
       
      bool skip_if_absent = 3;
      Returns:
      The skipIfAbsent.