Package io.envoyproxy.envoy.extensions.filters.http.ratelimit.v3

Class RateLimitConfig.Action.RequestHeaders.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

io.envoyproxy.envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action.RequestHeaders.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitConfig.Action.RequestHeadersOrBuilder, Cloneable

Enclosing class:

RateLimitConfig.Action.RequestHeaders

public static final class RateLimitConfig.Action.RequestHeaders.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>
implements RateLimitConfig.Action.RequestHeadersOrBuilder

 The following descriptor entry is appended when a header contains a key that matches the
 *header_name*:
 .. code-block:: cpp
   ("<descriptor_key>", "<header_value_queried_from_header>")
 

Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action.RequestHeaders

Method Summary

Modifier and Type	Method	Description
RateLimitConfig.Action.RequestHeaders.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RateLimitConfig.Action.RequestHeaders	build()
RateLimitConfig.Action.RequestHeaders	buildPartial()
RateLimitConfig.Action.RequestHeaders.Builder	clear()
RateLimitConfig.Action.RequestHeaders.Builder	clearDescriptorKey()	The key to use in the descriptor entry.
RateLimitConfig.Action.RequestHeaders.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RateLimitConfig.Action.RequestHeaders.Builder	clearHeaderName()	The header name to be queried from the request headers.
RateLimitConfig.Action.RequestHeaders.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RateLimitConfig.Action.RequestHeaders.Builder	clearSkipIfAbsent()	If set to true, Envoy skips the descriptor while calling rate limiting service when header is not present in the request.
RateLimitConfig.Action.RequestHeaders.Builder	clone()
RateLimitConfig.Action.RequestHeaders	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RateLimitConfig.Action.RequestHeaders.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RateLimitConfig.Action.RequestHeaders.Builder	mergeFrom(com.google.protobuf.Message other)
RateLimitConfig.Action.RequestHeaders.Builder	mergeFrom(RateLimitConfig.Action.RequestHeaders other)
RateLimitConfig.Action.RequestHeaders.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RateLimitConfig.Action.RequestHeaders.Builder	setDescriptorKey(String value)	The key to use in the descriptor entry.
RateLimitConfig.Action.RequestHeaders.Builder	setDescriptorKeyBytes(com.google.protobuf.ByteString value)	The key to use in the descriptor entry.
RateLimitConfig.Action.RequestHeaders.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RateLimitConfig.Action.RequestHeaders.Builder	setHeaderName(String value)	The header name to be queried from the request headers.
RateLimitConfig.Action.RequestHeaders.Builder	setHeaderNameBytes(com.google.protobuf.ByteString value)	The header name to be queried from the request headers.
RateLimitConfig.Action.RequestHeaders.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RateLimitConfig.Action.RequestHeaders.Builder	setSkipIfAbsent(boolean value)	If set to true, Envoy skips the descriptor while calling rate limiting service when header is not present in the request.
RateLimitConfig.Action.RequestHeaders.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

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

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

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

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.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

clear

public RateLimitConfig.Action.RequestHeaders.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.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.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.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

getDefaultInstanceForType

public RateLimitConfig.Action.RequestHeaders getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RateLimitConfig.Action.RequestHeaders build()

Specified by:

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

Specified by:

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

buildPartial

public RateLimitConfig.Action.RequestHeaders buildPartial()

Specified by:

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

Specified by:

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

clone

public RateLimitConfig.Action.RequestHeaders.Builder clone()

Specified by:

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

setField

public RateLimitConfig.Action.RequestHeaders.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              Object value)

Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

clearField

public RateLimitConfig.Action.RequestHeaders.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

clearOneof

public RateLimitConfig.Action.RequestHeaders.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

setRepeatedField

public RateLimitConfig.Action.RequestHeaders.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                      int index,
                                                                      Object value)

Specified by:

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

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

addRepeatedField

public RateLimitConfig.Action.RequestHeaders.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                      Object value)

Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

mergeFrom

public RateLimitConfig.Action.RequestHeaders.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<RateLimitConfig.Action.RequestHeaders.Builder>

mergeFrom

public RateLimitConfig.Action.RequestHeaders.Builder mergeFrom(RateLimitConfig.Action.RequestHeaders other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

mergeFrom

public RateLimitConfig.Action.RequestHeaders.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws 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<RateLimitConfig.Action.RequestHeaders.Builder>

Throws:

IOException

getHeaderName

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

Specified by:

getHeaderName in interface RateLimitConfig.Action.RequestHeadersOrBuilder

getHeaderNameBytes

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

Specified by:

getHeaderNameBytes in interface RateLimitConfig.Action.RequestHeadersOrBuilder

setHeaderName

public RateLimitConfig.Action.RequestHeaders.Builder setHeaderName(String value)

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

clearHeaderName

public RateLimitConfig.Action.RequestHeaders.Builder clearHeaderName()

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

setHeaderNameBytes

public RateLimitConfig.Action.RequestHeaders.Builder setHeaderNameBytes(com.google.protobuf.ByteString value)

 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

public String getDescriptorKey()

 The key to use in the descriptor entry.
 

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

Specified by:

getDescriptorKey in interface RateLimitConfig.Action.RequestHeadersOrBuilder

getDescriptorKeyBytes

public com.google.protobuf.ByteString getDescriptorKeyBytes()

 The key to use in the descriptor entry.
 

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

Specified by:

getDescriptorKeyBytes in interface RateLimitConfig.Action.RequestHeadersOrBuilder

setDescriptorKey

public RateLimitConfig.Action.RequestHeaders.Builder setDescriptorKey(String value)

 The key to use in the descriptor entry.
 

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

clearDescriptorKey

public RateLimitConfig.Action.RequestHeaders.Builder clearDescriptorKey()

 The key to use in the descriptor entry.
 

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

setDescriptorKeyBytes

public RateLimitConfig.Action.RequestHeaders.Builder setDescriptorKeyBytes(com.google.protobuf.ByteString value)

 The key to use in the descriptor entry.
 

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

getSkipIfAbsent

public 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;

Specified by:

getSkipIfAbsent in interface RateLimitConfig.Action.RequestHeadersOrBuilder

setSkipIfAbsent

public RateLimitConfig.Action.RequestHeaders.Builder setSkipIfAbsent(boolean value)

 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;

clearSkipIfAbsent

public RateLimitConfig.Action.RequestHeaders.Builder clearSkipIfAbsent()

 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;

setUnknownFields

public final RateLimitConfig.Action.RequestHeaders.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>

mergeUnknownFields

public final RateLimitConfig.Action.RequestHeaders.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Action.RequestHeaders.Builder>