Class RateLimit.Action.RequestHeaders.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.RequestHeaders.Builder>
-
- io.envoyproxy.envoy.config.route.v3.RateLimit.Action.RequestHeaders.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimit.Action.RequestHeadersOrBuilder
,java.lang.Cloneable
- Enclosing class:
- RateLimit.Action.RequestHeaders
public static final class RateLimit.Action.RequestHeaders.Builder extends com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.RequestHeaders.Builder> implements RateLimit.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 typeenvoy.config.route.v3.RateLimit.Action.RequestHeaders
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private java.lang.Object
descriptorKey_
private java.lang.Object
headerName_
private boolean
skipIfAbsent_
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RateLimit.Action.RequestHeaders
build()
RateLimit.Action.RequestHeaders
buildPartial()
private void
buildPartial0(RateLimit.Action.RequestHeaders result)
RateLimit.Action.RequestHeaders.Builder
clear()
RateLimit.Action.RequestHeaders.Builder
clearDescriptorKey()
The key to use in the descriptor entry.RateLimit.Action.RequestHeaders.Builder
clearHeaderName()
The header name to be queried from the request headers.RateLimit.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.RateLimit.Action.RequestHeaders
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
java.lang.String
getDescriptorKey()
The key to use in the descriptor entry.com.google.protobuf.ByteString
getDescriptorKeyBytes()
The key to use in the descriptor entry.java.lang.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.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
RateLimit.Action.RequestHeaders.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RateLimit.Action.RequestHeaders.Builder
mergeFrom(com.google.protobuf.Message other)
RateLimit.Action.RequestHeaders.Builder
mergeFrom(RateLimit.Action.RequestHeaders other)
RateLimit.Action.RequestHeaders.Builder
setDescriptorKey(java.lang.String value)
The key to use in the descriptor entry.RateLimit.Action.RequestHeaders.Builder
setDescriptorKeyBytes(com.google.protobuf.ByteString value)
The key to use in the descriptor entry.RateLimit.Action.RequestHeaders.Builder
setHeaderName(java.lang.String value)
The header name to be queried from the request headers.RateLimit.Action.RequestHeaders.Builder
setHeaderNameBytes(com.google.protobuf.ByteString value)
The header name to be queried from the request headers.RateLimit.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.-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.RequestHeaders.Builder>
-
clear
public RateLimit.Action.RequestHeaders.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.RequestHeaders.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.RequestHeaders.Builder>
-
getDefaultInstanceForType
public RateLimit.Action.RequestHeaders getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public RateLimit.Action.RequestHeaders build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public RateLimit.Action.RequestHeaders buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
private void buildPartial0(RateLimit.Action.RequestHeaders result)
-
mergeFrom
public RateLimit.Action.RequestHeaders.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RateLimit.Action.RequestHeaders.Builder>
-
mergeFrom
public RateLimit.Action.RequestHeaders.Builder mergeFrom(RateLimit.Action.RequestHeaders other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.RequestHeaders.Builder>
-
mergeFrom
public RateLimit.Action.RequestHeaders.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RateLimit.Action.RequestHeaders.Builder>
- Throws:
java.io.IOException
-
getHeaderName
public java.lang.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 interfaceRateLimit.Action.RequestHeadersOrBuilder
- Returns:
- The headerName.
-
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 interfaceRateLimit.Action.RequestHeadersOrBuilder
- Returns:
- The bytes for headerName.
-
setHeaderName
public RateLimit.Action.RequestHeaders.Builder setHeaderName(java.lang.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) = { ... }
- Parameters:
value
- The headerName to set.- Returns:
- This builder for chaining.
-
clearHeaderName
public RateLimit.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) = { ... }
- Returns:
- This builder for chaining.
-
setHeaderNameBytes
public RateLimit.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) = { ... }
- Parameters:
value
- The bytes for headerName to set.- Returns:
- This builder for chaining.
-
getDescriptorKey
public java.lang.String getDescriptorKey()
The key to use in the descriptor entry.
string descriptor_key = 2 [(.validate.rules) = { ... }
- Specified by:
getDescriptorKey
in interfaceRateLimit.Action.RequestHeadersOrBuilder
- Returns:
- The descriptorKey.
-
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 interfaceRateLimit.Action.RequestHeadersOrBuilder
- Returns:
- The bytes for descriptorKey.
-
setDescriptorKey
public RateLimit.Action.RequestHeaders.Builder setDescriptorKey(java.lang.String value)
The key to use in the descriptor entry.
string descriptor_key = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The descriptorKey to set.- Returns:
- This builder for chaining.
-
clearDescriptorKey
public RateLimit.Action.RequestHeaders.Builder clearDescriptorKey()
The key to use in the descriptor entry.
string descriptor_key = 2 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setDescriptorKeyBytes
public RateLimit.Action.RequestHeaders.Builder setDescriptorKeyBytes(com.google.protobuf.ByteString value)
The key to use in the descriptor entry.
string descriptor_key = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for descriptorKey to set.- Returns:
- This builder for chaining.
-
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 interfaceRateLimit.Action.RequestHeadersOrBuilder
- Returns:
- The skipIfAbsent.
-
setSkipIfAbsent
public RateLimit.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;
- Parameters:
value
- The skipIfAbsent to set.- Returns:
- This builder for chaining.
-
clearSkipIfAbsent
public RateLimit.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;
- Returns:
- This builder for chaining.
-
-