Class RateLimit.Action.MetaData.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.MetaData.Builder>
com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.MetaData.Builder>
io.envoyproxy.envoy.config.route.v3.RateLimit.Action.MetaData.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimit.Action.MetaDataOrBuilder
,Cloneable
- Enclosing class:
RateLimit.Action.MetaData
public static final class RateLimit.Action.MetaData.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.MetaData.Builder>
implements RateLimit.Action.MetaDataOrBuilder
The following descriptor entry is appended when the metadata contains a key value: .. code-block:: cpp ("<descriptor_key>", "<value_queried_from_metadata>") [#next-free-field: 6]Protobuf type
envoy.config.route.v3.RateLimit.Action.MetaData
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private Object
private Object
private MetadataKey
private com.google.protobuf.SingleFieldBuilder
<MetadataKey, MetadataKey.Builder, MetadataKeyOrBuilder> private boolean
private int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
private void
clear()
An optional value to use if ``metadata_key`` is empty.The key to use in the descriptor entry.Metadata struct that defines the key and path to retrieve the string value.If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set.Source of metadataAn optional value to use if ``metadata_key`` is empty.com.google.protobuf.ByteString
An optional value to use if ``metadata_key`` is empty.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
The key to use in the descriptor entry.com.google.protobuf.ByteString
The key to use in the descriptor entry.Metadata struct that defines the key and path to retrieve the string value.Metadata struct that defines the key and path to retrieve the string value.Metadata struct that defines the key and path to retrieve the string value.boolean
If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set.Source of metadataint
Source of metadataboolean
Metadata struct that defines the key and path to retrieve the string value.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
private com.google.protobuf.SingleFieldBuilder
<MetadataKey, MetadataKey.Builder, MetadataKeyOrBuilder> Metadata struct that defines the key and path to retrieve the string value.final boolean
private void
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeMetadataKey
(MetadataKey value) Metadata struct that defines the key and path to retrieve the string value.setDefaultValue
(String value) An optional value to use if ``metadata_key`` is empty.setDefaultValueBytes
(com.google.protobuf.ByteString value) An optional value to use if ``metadata_key`` is empty.setDescriptorKey
(String value) The key to use in the descriptor entry.setDescriptorKeyBytes
(com.google.protobuf.ByteString value) The key to use in the descriptor entry.setMetadataKey
(MetadataKey value) Metadata struct that defines the key and path to retrieve the string value.setMetadataKey
(MetadataKey.Builder builderForValue) Metadata struct that defines the key and path to retrieve the string value.setSkipIfAbsent
(boolean value) If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set.Source of metadatasetSourceValue
(int value) Source of metadataMethods 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
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
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
-
Field Details
-
bitField0_
private int bitField0_ -
descriptorKey_
-
metadataKey_
-
metadataKeyBuilder_
private com.google.protobuf.SingleFieldBuilder<MetadataKey,MetadataKey.Builder, metadataKeyBuilder_MetadataKeyOrBuilder> -
defaultValue_
-
source_
private int source_ -
skipIfAbsent_
private boolean skipIfAbsent_
-
-
Constructor Details
-
Builder
private Builder() -
Builder
private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
-
-
Method Details
-
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.MetaData.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization() -
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.MetaData.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.MetaData.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RateLimit.Action.MetaData.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.MetaData.Builder>
-
mergeFrom
public RateLimit.Action.MetaData.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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.MetaData.Builder>
- Throws:
IOException
-
getDescriptorKey
The key to use in the descriptor entry.
string descriptor_key = 1 [(.validate.rules) = { ... }
- Specified by:
getDescriptorKey
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The descriptorKey.
-
getDescriptorKeyBytes
public com.google.protobuf.ByteString getDescriptorKeyBytes()The key to use in the descriptor entry.
string descriptor_key = 1 [(.validate.rules) = { ... }
- Specified by:
getDescriptorKeyBytes
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The bytes for descriptorKey.
-
setDescriptorKey
The key to use in the descriptor entry.
string descriptor_key = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The descriptorKey to set.- Returns:
- This builder for chaining.
-
clearDescriptorKey
The key to use in the descriptor entry.
string descriptor_key = 1 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setDescriptorKeyBytes
public RateLimit.Action.MetaData.Builder setDescriptorKeyBytes(com.google.protobuf.ByteString value) The key to use in the descriptor entry.
string descriptor_key = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for descriptorKey to set.- Returns:
- This builder for chaining.
-
hasMetadataKey
public boolean hasMetadataKey()Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
- Specified by:
hasMetadataKey
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- Whether the metadataKey field is set.
-
getMetadataKey
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
- Specified by:
getMetadataKey
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The metadataKey.
-
setMetadataKey
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
-
setMetadataKey
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
-
mergeMetadataKey
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
-
clearMetadataKey
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
-
getMetadataKeyBuilder
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
-
getMetadataKeyOrBuilder
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
- Specified by:
getMetadataKeyOrBuilder
in interfaceRateLimit.Action.MetaDataOrBuilder
-
internalGetMetadataKeyFieldBuilder
private com.google.protobuf.SingleFieldBuilder<MetadataKey,MetadataKey.Builder, internalGetMetadataKeyFieldBuilder()MetadataKeyOrBuilder> Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
-
getDefaultValue
An optional value to use if ``metadata_key`` is empty. If not set and no value is present under the metadata_key then ``skip_if_absent`` is followed to skip calling the rate limiting service or skip the descriptor.
string default_value = 3;
- Specified by:
getDefaultValue
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The defaultValue.
-
getDefaultValueBytes
public com.google.protobuf.ByteString getDefaultValueBytes()An optional value to use if ``metadata_key`` is empty. If not set and no value is present under the metadata_key then ``skip_if_absent`` is followed to skip calling the rate limiting service or skip the descriptor.
string default_value = 3;
- Specified by:
getDefaultValueBytes
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The bytes for defaultValue.
-
setDefaultValue
An optional value to use if ``metadata_key`` is empty. If not set and no value is present under the metadata_key then ``skip_if_absent`` is followed to skip calling the rate limiting service or skip the descriptor.
string default_value = 3;
- Parameters:
value
- The defaultValue to set.- Returns:
- This builder for chaining.
-
clearDefaultValue
An optional value to use if ``metadata_key`` is empty. If not set and no value is present under the metadata_key then ``skip_if_absent`` is followed to skip calling the rate limiting service or skip the descriptor.
string default_value = 3;
- Returns:
- This builder for chaining.
-
setDefaultValueBytes
An optional value to use if ``metadata_key`` is empty. If not set and no value is present under the metadata_key then ``skip_if_absent`` is followed to skip calling the rate limiting service or skip the descriptor.
string default_value = 3;
- Parameters:
value
- The bytes for defaultValue to set.- Returns:
- This builder for chaining.
-
getSourceValue
public int getSourceValue()Source of metadata
.envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
- Specified by:
getSourceValue
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The enum numeric value on the wire for source.
-
setSourceValue
Source of metadata
.envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
- Parameters:
value
- The enum numeric value on the wire for source to set.- Returns:
- This builder for chaining.
-
getSource
Source of metadata
.envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
- Specified by:
getSource
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The source.
-
setSource
Source of metadata
.envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
- Parameters:
value
- The source to set.- Returns:
- This builder for chaining.
-
clearSource
Source of metadata
.envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
getSkipIfAbsent
public boolean getSkipIfAbsent()If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set. By default it skips calling the rate limiting service in that case.
bool skip_if_absent = 5;
- Specified by:
getSkipIfAbsent
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The skipIfAbsent.
-
setSkipIfAbsent
If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set. By default it skips calling the rate limiting service in that case.
bool skip_if_absent = 5;
- Parameters:
value
- The skipIfAbsent to set.- Returns:
- This builder for chaining.
-
clearSkipIfAbsent
If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set. By default it skips calling the rate limiting service in that case.
bool skip_if_absent = 5;
- Returns:
- This builder for chaining.
-