Package io.envoyproxy.envoy.config.route.v3

Class RateLimit.Action.MetaData

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.MetaDataOrBuilder, java.io.Serializable
    Enclosing class:
    RateLimit.Action
    public static final class RateLimit.Action.MetaData
extends com.google.protobuf.GeneratedMessage
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
    See Also:
    Serialized Form

    • Field Detail

      • bitField0_

        private int bitField0_

      • DESCRIPTOR_KEY_FIELD_NUMBER

        public static final int DESCRIPTOR_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • descriptorKey_

        private volatile java.lang.Object descriptorKey_

      • METADATA_KEY_FIELD_NUMBER

        public static final int METADATA_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEFAULT_VALUE_FIELD_NUMBER

        public static final int DEFAULT_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • defaultValue_

        private volatile java.lang.Object defaultValue_

      • source_

        private int source_

      • SKIP_IF_ABSENT_FIELD_NUMBER

        public static final int SKIP_IF_ABSENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • skipIfAbsent_

        private boolean skipIfAbsent_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

    • Constructor Detail

      • MetaData

        private MetaData​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • MetaData

        private MetaData()

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • getDescriptorKey

        public java.lang.String getDescriptorKey()
         The key to use in the descriptor entry.
        string descriptor_key = 1 [(.validate.rules) = { ... }
        Specified by:
        getDescriptorKey in interface RateLimit.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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The bytes for descriptorKey.

      • 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 interface RateLimit.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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The metadataKey.

      • 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 interface RateLimit.Action.MetaDataOrBuilder

      • 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 interface RateLimit.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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The bytes for defaultValue.

      • getSourceValue

        public int getSourceValue()
         Source of metadata
        .envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
        Specified by:
        getSourceValue in interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The enum numeric value on the wire for source.

      • 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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The skipIfAbsent.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(java.nio.ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(java.nio.ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RateLimit.Action.MetaData parseDelimitedFrom​(java.io.InputStream input)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RateLimit.Action.MetaData parseDelimitedFrom​(java.io.InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(com.google.protobuf.CodedInputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RateLimit.Action.MetaData parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public RateLimit.Action.MetaData.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public RateLimit.Action.MetaData.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RateLimit.Action.MetaData.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getParserForType

        public com.google.protobuf.Parser<RateLimit.Action.MetaData> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

        public RateLimit.Action.MetaData getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder