io.envoyproxy.envoy.config.route.v3

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 and Description
String	getDescriptorKey() The key to use in the descriptor entry.
com.google.protobuf.ByteString	getDescriptorKeyBytes() The key to use in the descriptor entry.
String	getHeaderName() The header name to be queried from the request headers.
com.google.protobuf.ByteString	getHeaderNameBytes() The header name to be queried from the request headers.
boolean	getSkipIfAbsent() 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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) = { ... }

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) = { ... }

getDescriptorKey

String getDescriptorKey()

 The key to use in the descriptor entry.
 

string descriptor_key = 2 [(.validate.rules) = { ... }

getDescriptorKeyBytes

com.google.protobuf.ByteString getDescriptorKeyBytes()

 The key to use in the descriptor entry.
 

string descriptor_key = 2 [(.validate.rules) = { ... }

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;