Class RateLimit.Action.MetaData.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- 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
,java.lang.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 typeenvoy.config.route.v3.RateLimit.Action.MetaData
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private java.lang.Object
defaultValue_
private java.lang.Object
descriptorKey_
private MetadataKey
metadataKey_
private com.google.protobuf.SingleFieldBuilder<MetadataKey,MetadataKey.Builder,MetadataKeyOrBuilder>
metadataKeyBuilder_
private boolean
skipIfAbsent_
private int
source_
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RateLimit.Action.MetaData
build()
RateLimit.Action.MetaData
buildPartial()
private void
buildPartial0(RateLimit.Action.MetaData result)
RateLimit.Action.MetaData.Builder
clear()
RateLimit.Action.MetaData.Builder
clearDefaultValue()
An optional value to use if ``metadata_key`` is empty.RateLimit.Action.MetaData.Builder
clearDescriptorKey()
The key to use in the descriptor entry.RateLimit.Action.MetaData.Builder
clearMetadataKey()
Metadata struct that defines the key and path to retrieve the string value.RateLimit.Action.MetaData.Builder
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.RateLimit.Action.MetaData.Builder
clearSource()
Source of metadataRateLimit.Action.MetaData
getDefaultInstanceForType()
java.lang.String
getDefaultValue()
An optional value to use if ``metadata_key`` is empty.com.google.protobuf.ByteString
getDefaultValueBytes()
An optional value to use if ``metadata_key`` is empty.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.MetadataKey
getMetadataKey()
Metadata struct that defines the key and path to retrieve the string value.MetadataKey.Builder
getMetadataKeyBuilder()
Metadata struct that defines the key and path to retrieve the string value.private com.google.protobuf.SingleFieldBuilder<MetadataKey,MetadataKey.Builder,MetadataKeyOrBuilder>
getMetadataKeyFieldBuilder()
Metadata struct that defines the key and path to retrieve the string value.MetadataKeyOrBuilder
getMetadataKeyOrBuilder()
Metadata struct that defines the key and path to retrieve the string value.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.RateLimit.Action.MetaData.Source
getSource()
Source of metadataint
getSourceValue()
Source of metadataboolean
hasMetadataKey()
Metadata struct that defines the key and path to retrieve the string value.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
private void
maybeForceBuilderInitialization()
RateLimit.Action.MetaData.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RateLimit.Action.MetaData.Builder
mergeFrom(com.google.protobuf.Message other)
RateLimit.Action.MetaData.Builder
mergeFrom(RateLimit.Action.MetaData other)
RateLimit.Action.MetaData.Builder
mergeMetadataKey(MetadataKey value)
Metadata struct that defines the key and path to retrieve the string value.RateLimit.Action.MetaData.Builder
setDefaultValue(java.lang.String value)
An optional value to use if ``metadata_key`` is empty.RateLimit.Action.MetaData.Builder
setDefaultValueBytes(com.google.protobuf.ByteString value)
An optional value to use if ``metadata_key`` is empty.RateLimit.Action.MetaData.Builder
setDescriptorKey(java.lang.String value)
The key to use in the descriptor entry.RateLimit.Action.MetaData.Builder
setDescriptorKeyBytes(com.google.protobuf.ByteString value)
The key to use in the descriptor entry.RateLimit.Action.MetaData.Builder
setMetadataKey(MetadataKey value)
Metadata struct that defines the key and path to retrieve the string value.RateLimit.Action.MetaData.Builder
setMetadataKey(MetadataKey.Builder builderForValue)
Metadata struct that defines the key and path to retrieve the string value.RateLimit.Action.MetaData.Builder
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.RateLimit.Action.MetaData.Builder
setSource(RateLimit.Action.MetaData.Source value)
Source of metadataRateLimit.Action.MetaData.Builder
setSourceValue(int value)
Source of metadata-
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
-
-
-
-
Field Detail
-
bitField0_
private int bitField0_
-
descriptorKey_
private java.lang.Object descriptorKey_
-
metadataKey_
private MetadataKey metadataKey_
-
metadataKeyBuilder_
private com.google.protobuf.SingleFieldBuilder<MetadataKey,MetadataKey.Builder,MetadataKeyOrBuilder> metadataKeyBuilder_
-
defaultValue_
private java.lang.Object defaultValue_
-
source_
private int source_
-
skipIfAbsent_
private boolean skipIfAbsent_
-
-
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.MetaData.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization()
-
clear
public RateLimit.Action.MetaData.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.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
public RateLimit.Action.MetaData getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public RateLimit.Action.MetaData build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public RateLimit.Action.MetaData 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.MetaData result)
-
mergeFrom
public RateLimit.Action.MetaData.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.MetaData.Builder>
-
mergeFrom
public RateLimit.Action.MetaData.Builder mergeFrom(RateLimit.Action.MetaData other)
-
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 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.MetaData.Builder>
- Throws:
java.io.IOException
-
getDescriptorKey
public java.lang.String 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
public RateLimit.Action.MetaData.Builder setDescriptorKey(java.lang.String value)
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
public RateLimit.Action.MetaData.Builder 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
public MetadataKey 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
public RateLimit.Action.MetaData.Builder setMetadataKey(MetadataKey value)
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
public RateLimit.Action.MetaData.Builder setMetadataKey(MetadataKey.Builder builderForValue)
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
public RateLimit.Action.MetaData.Builder mergeMetadataKey(MetadataKey value)
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
public RateLimit.Action.MetaData.Builder 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
public MetadataKey.Builder 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
public MetadataKeyOrBuilder 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
-
getMetadataKeyFieldBuilder
private com.google.protobuf.SingleFieldBuilder<MetadataKey,MetadataKey.Builder,MetadataKeyOrBuilder> getMetadataKeyFieldBuilder()
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
public java.lang.String 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
public RateLimit.Action.MetaData.Builder setDefaultValue(java.lang.String value)
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
public RateLimit.Action.MetaData.Builder 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
public RateLimit.Action.MetaData.Builder setDefaultValueBytes(com.google.protobuf.ByteString value)
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
public RateLimit.Action.MetaData.Builder setSourceValue(int value)
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
public RateLimit.Action.MetaData.Source 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
public RateLimit.Action.MetaData.Builder setSource(RateLimit.Action.MetaData.Source value)
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
public RateLimit.Action.MetaData.Builder 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
public RateLimit.Action.MetaData.Builder 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. 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
public RateLimit.Action.MetaData.Builder 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.
-
-