Package io.envoyproxy.envoy.extensions.filters.http.bandwidth_limit.v3

Interface BandwidthLimitOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    BandwidthLimit, BandwidthLimit.Builder
    public interface BandwidthLimitOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      BandwidthLimit.EnableMode getEnableMode()
      The enable mode for the bandwidth limit filter.
      int getEnableModeValue()
      The enable mode for the bandwidth limit filter.
      boolean getEnableResponseTrailers()
      Enable response trailers. .. note:: * If set true, the response trailers ``bandwidth-request-delay-ms`` and ``bandwidth-response-delay-ms`` will be added, prefixed by ``response_trailer_prefix``
      com.google.protobuf.Duration getFillInterval()
      Optional Fill interval in milliseconds for the token refills.
      com.google.protobuf.DurationOrBuilder getFillIntervalOrBuilder()
      Optional Fill interval in milliseconds for the token refills.
      com.google.protobuf.UInt64Value getLimitKbps()
      The limit supplied in KiB/s. .. note:: It's fine for the limit to be unset for the global configuration since the bandwidth limit can be applied at a the virtual host or route level.
      com.google.protobuf.UInt64ValueOrBuilder getLimitKbpsOrBuilder()
      The limit supplied in KiB/s. .. note:: It's fine for the limit to be unset for the global configuration since the bandwidth limit can be applied at a the virtual host or route level.
      String getResponseTrailerPrefix()
      Optional The prefix for the response trailers.
      com.google.protobuf.ByteString getResponseTrailerPrefixBytes()
      Optional The prefix for the response trailers.
      RuntimeFeatureFlag getRuntimeEnabled()
      Runtime flag that controls whether the filter is enabled or not.
      RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
      Runtime flag that controls whether the filter is enabled or not.
      String getStatPrefix()
      The human readable prefix to use when emitting stats.
      com.google.protobuf.ByteString getStatPrefixBytes()
      The human readable prefix to use when emitting stats.
      boolean hasFillInterval()
      Optional Fill interval in milliseconds for the token refills.
      boolean hasLimitKbps()
      The limit supplied in KiB/s. .. note:: It's fine for the limit to be unset for the global configuration since the bandwidth limit can be applied at a the virtual host or route level.
      boolean hasRuntimeEnabled()
      Runtime flag that controls whether the filter is enabled or not.

      • 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 Detail

      • getStatPrefix

        String getStatPrefix()
         The human readable prefix to use when emitting stats.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        com.google.protobuf.ByteString getStatPrefixBytes()
         The human readable prefix to use when emitting stats.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for statPrefix.

      • getEnableModeValue

        int getEnableModeValue()
         The enable mode for the bandwidth limit filter.
 Default is Disabled.
        .envoy.extensions.filters.http.bandwidth_limit.v3.BandwidthLimit.EnableMode enable_mode = 2 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for enableMode.

      • getEnableMode

        BandwidthLimit.EnableMode getEnableMode()
         The enable mode for the bandwidth limit filter.
 Default is Disabled.
        .envoy.extensions.filters.http.bandwidth_limit.v3.BandwidthLimit.EnableMode enable_mode = 2 [(.validate.rules) = { ... }
        Returns:
        The enableMode.

      • hasLimitKbps

        boolean hasLimitKbps()
         The limit supplied in KiB/s.
 .. note::
   It's fine for the limit to be unset for the global configuration since the bandwidth limit
   can be applied at a the virtual host or route level. Thus, the limit must be set for the
   per route configuration otherwise the config will be rejected.
 .. note::
   When using per route configuration, the limit becomes unique to that route.
        .google.protobuf.UInt64Value limit_kbps = 3 [(.validate.rules) = { ... }
        Returns:
        Whether the limitKbps field is set.

      • getLimitKbps

        com.google.protobuf.UInt64Value getLimitKbps()
         The limit supplied in KiB/s.
 .. note::
   It's fine for the limit to be unset for the global configuration since the bandwidth limit
   can be applied at a the virtual host or route level. Thus, the limit must be set for the
   per route configuration otherwise the config will be rejected.
 .. note::
   When using per route configuration, the limit becomes unique to that route.
        .google.protobuf.UInt64Value limit_kbps = 3 [(.validate.rules) = { ... }
        Returns:
        The limitKbps.

      • getLimitKbpsOrBuilder

        com.google.protobuf.UInt64ValueOrBuilder getLimitKbpsOrBuilder()
         The limit supplied in KiB/s.
 .. note::
   It's fine for the limit to be unset for the global configuration since the bandwidth limit
   can be applied at a the virtual host or route level. Thus, the limit must be set for the
   per route configuration otherwise the config will be rejected.
 .. note::
   When using per route configuration, the limit becomes unique to that route.
        .google.protobuf.UInt64Value limit_kbps = 3 [(.validate.rules) = { ... }

      • hasFillInterval

        boolean hasFillInterval()
         Optional Fill interval in milliseconds for the token refills. Defaults to 50ms.
 It must be at least 20ms to avoid too aggressive refills.
        .google.protobuf.Duration fill_interval = 4 [(.validate.rules) = { ... }
        Returns:
        Whether the fillInterval field is set.

      • getFillInterval

        com.google.protobuf.Duration getFillInterval()
         Optional Fill interval in milliseconds for the token refills. Defaults to 50ms.
 It must be at least 20ms to avoid too aggressive refills.
        .google.protobuf.Duration fill_interval = 4 [(.validate.rules) = { ... }
        Returns:
        The fillInterval.

      • getFillIntervalOrBuilder

        com.google.protobuf.DurationOrBuilder getFillIntervalOrBuilder()
         Optional Fill interval in milliseconds for the token refills. Defaults to 50ms.
 It must be at least 20ms to avoid too aggressive refills.
        .google.protobuf.Duration fill_interval = 4 [(.validate.rules) = { ... }

      • hasRuntimeEnabled

        boolean hasRuntimeEnabled()
         Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
        .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5;
        Returns:
        Whether the runtimeEnabled field is set.

      • getRuntimeEnabled

        RuntimeFeatureFlag getRuntimeEnabled()
         Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
        .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5;
        Returns:
        The runtimeEnabled.

      • getRuntimeEnabledOrBuilder

        RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
         Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
        .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5;

      • getEnableResponseTrailers

        boolean getEnableResponseTrailers()
         Enable response trailers.
 .. note::
   * If set true, the response trailers ``bandwidth-request-delay-ms`` and ``bandwidth-response-delay-ms`` will be added, prefixed by ``response_trailer_prefix``.
   * bandwidth-request-delay-ms: delay time in milliseconds it took for the request stream transfer.
   * bandwidth-response-delay-ms: delay time in milliseconds it took for the response stream transfer.
   * If :ref:`enable_mode <envoy_v3_api_field_extensions.filters.http.bandwidth_limit.v3.BandwidthLimit.enable_mode>` is ``DISABLED`` or ``REQUEST``, the trailers will not be set.
   * If both the request and response delay time is 0, the trailers will not be set.
        bool enable_response_trailers = 6;
        Returns:
        The enableResponseTrailers.

      • getResponseTrailerPrefix

        String getResponseTrailerPrefix()
         Optional The prefix for the response trailers.
        string response_trailer_prefix = 7 [(.validate.rules) = { ... }
        Returns:
        The responseTrailerPrefix.

      • getResponseTrailerPrefixBytes

        com.google.protobuf.ByteString getResponseTrailerPrefixBytes()
         Optional The prefix for the response trailers.
        string response_trailer_prefix = 7 [(.validate.rules) = { ... }
        Returns:
        The bytes for responseTrailerPrefix.