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

Interface RateLimit.Action.MetaDataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RateLimit.Action.MetaData, RateLimit.Action.MetaData.Builder
Enclosing class:
RateLimit.Action
public static interface RateLimit.Action.MetaDataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    MetadataKeyOrBuilder
    getMetadataKeyOrBuilder()
    Metadata struct that defines the key and path to retrieve the string value.
    boolean
    getSkipIfAbsent()
    Controls the behavior when the specified ``metadata_key`` is empty and ``default_value`` is not set.
    RateLimit.Action.MetaData.Source
    getSource()
    Source of metadata
    int
    getSourceValue()
    Source of metadata
    boolean
    hasMetadataKey()
    Metadata struct that defines the key and path to retrieve the string value.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptorKey

      String getDescriptorKey()
       The key to use in the descriptor entry.
      string descriptor_key = 1 [(.validate.rules) = { ... }
      Returns:
      The descriptorKey.

    • getDescriptorKeyBytes

      com.google.protobuf.ByteString getDescriptorKeyBytes()
       The key to use in the descriptor entry.
      string descriptor_key = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for descriptorKey.

    • hasMetadataKey

      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) = { ... }
      Returns:
      Whether the metadataKey field is set.

    • getMetadataKey

      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) = { ... }
      Returns:
      The metadataKey.

    • getMetadataKeyOrBuilder

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

    • getDefaultValue

      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;
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      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;
      Returns:
      The bytes for defaultValue.

    • getSourceValue

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

    • getSource

      RateLimit.Action.MetaData.Source getSource()
       Source of metadata
      .envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
      Returns:
      The source.

    • getSkipIfAbsent

      boolean getSkipIfAbsent()
       Controls the behavior when the specified ``metadata_key`` is empty and ``default_value`` is not set.

 If set to ``false`` (default):

 * Envoy does **NOT** call the rate limiting service for this descriptor.
 * Useful if the metadata is optional and you prefer to skip rate limiting when it's absent.

 If set to ``true``:

 * Envoy calls the rate limiting service but omits this descriptor if the ``metadata_key`` is empty and
   ``default_value`` is missing.
 * Useful if you want Envoy to enforce rate limiting even when the metadata is not present.
      bool skip_if_absent = 5;
      Returns:
      The skipIfAbsent.