Interface LeastRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    LeastRequest, LeastRequest.Builder

    public interface LeastRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      RuntimeDouble getActiveRequestBias()
      The following formula is used to calculate the dynamic weights when hosts have different load balancing weights: ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias`` The larger the active request bias is, the more aggressively active requests will lower the effective weight when all host weights are not equal.
      RuntimeDoubleOrBuilder getActiveRequestBiasOrBuilder()
      The following formula is used to calculate the dynamic weights when hosts have different load balancing weights: ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias`` The larger the active request bias is, the more aggressively active requests will lower the effective weight when all host weights are not equal.
      com.google.protobuf.UInt32Value getChoiceCount()
      The number of random healthy hosts from which the host with the fewest active requests will be chosen.
      com.google.protobuf.UInt32ValueOrBuilder getChoiceCountOrBuilder()
      The number of random healthy hosts from which the host with the fewest active requests will be chosen.
      com.google.protobuf.BoolValue getEnableFullScan()
      Deprecated.
      envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated.
      com.google.protobuf.BoolValueOrBuilder getEnableFullScanOrBuilder()
      Deprecated.
      LocalityLbConfig getLocalityLbConfig()
      Configuration for local zone aware load balancing or locality weighted load balancing.
      LocalityLbConfigOrBuilder getLocalityLbConfigOrBuilder()
      Configuration for local zone aware load balancing or locality weighted load balancing.
      LeastRequest.SelectionMethod getSelectionMethod()
      Method for selecting the host set from which to return the host with the fewest active requests.
      int getSelectionMethodValue()
      Method for selecting the host set from which to return the host with the fewest active requests.
      SlowStartConfig getSlowStartConfig()
      Configuration for slow start mode.
      SlowStartConfigOrBuilder getSlowStartConfigOrBuilder()
      Configuration for slow start mode.
      boolean hasActiveRequestBias()
      The following formula is used to calculate the dynamic weights when hosts have different load balancing weights: ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias`` The larger the active request bias is, the more aggressively active requests will lower the effective weight when all host weights are not equal.
      boolean hasChoiceCount()
      The number of random healthy hosts from which the host with the fewest active requests will be chosen.
      boolean hasEnableFullScan()
      Deprecated.
      envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated.
      boolean hasLocalityLbConfig()
      Configuration for local zone aware load balancing or locality weighted load balancing.
      boolean hasSlowStartConfig()
      Configuration for slow start mode.
      • 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

      • hasChoiceCount

        boolean hasChoiceCount()
         The number of random healthy hosts from which the host with the fewest active requests will
         be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set.
         Only applies to the ``N_CHOICES`` selection method.
         
        .google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }
        Returns:
        Whether the choiceCount field is set.
      • getChoiceCount

        com.google.protobuf.UInt32Value getChoiceCount()
         The number of random healthy hosts from which the host with the fewest active requests will
         be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set.
         Only applies to the ``N_CHOICES`` selection method.
         
        .google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }
        Returns:
        The choiceCount.
      • getChoiceCountOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getChoiceCountOrBuilder()
         The number of random healthy hosts from which the host with the fewest active requests will
         be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set.
         Only applies to the ``N_CHOICES`` selection method.
         
        .google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }
      • hasActiveRequestBias

        boolean hasActiveRequestBias()
         The following formula is used to calculate the dynamic weights when hosts have different load
         balancing weights:
        
         ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias``
        
         The larger the active request bias is, the more aggressively active requests will lower the
         effective weight when all host weights are not equal.
        
         ``active_request_bias`` must be greater than or equal to 0.0.
        
         When ``active_request_bias == 0.0`` the Least Request Load Balancer doesn't consider the number
         of active requests at the time it picks a host and behaves like the Round Robin Load
         Balancer.
        
         When ``active_request_bias > 0.0`` the Least Request Load Balancer scales the load balancing
         weight by the number of active requests at the time it does a pick.
        
         The value is cached for performance reasons and refreshed whenever one of the Load Balancer's
         host sets changes, e.g., whenever there is a host membership update or a host load balancing
         weight change.
        
         .. note::
         This setting only takes effect if all host weights are not equal.
         
        .envoy.config.core.v3.RuntimeDouble active_request_bias = 2;
        Returns:
        Whether the activeRequestBias field is set.
      • getActiveRequestBias

        RuntimeDouble getActiveRequestBias()
         The following formula is used to calculate the dynamic weights when hosts have different load
         balancing weights:
        
         ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias``
        
         The larger the active request bias is, the more aggressively active requests will lower the
         effective weight when all host weights are not equal.
        
         ``active_request_bias`` must be greater than or equal to 0.0.
        
         When ``active_request_bias == 0.0`` the Least Request Load Balancer doesn't consider the number
         of active requests at the time it picks a host and behaves like the Round Robin Load
         Balancer.
        
         When ``active_request_bias > 0.0`` the Least Request Load Balancer scales the load balancing
         weight by the number of active requests at the time it does a pick.
        
         The value is cached for performance reasons and refreshed whenever one of the Load Balancer's
         host sets changes, e.g., whenever there is a host membership update or a host load balancing
         weight change.
        
         .. note::
         This setting only takes effect if all host weights are not equal.
         
        .envoy.config.core.v3.RuntimeDouble active_request_bias = 2;
        Returns:
        The activeRequestBias.
      • getActiveRequestBiasOrBuilder

        RuntimeDoubleOrBuilder getActiveRequestBiasOrBuilder()
         The following formula is used to calculate the dynamic weights when hosts have different load
         balancing weights:
        
         ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias``
        
         The larger the active request bias is, the more aggressively active requests will lower the
         effective weight when all host weights are not equal.
        
         ``active_request_bias`` must be greater than or equal to 0.0.
        
         When ``active_request_bias == 0.0`` the Least Request Load Balancer doesn't consider the number
         of active requests at the time it picks a host and behaves like the Round Robin Load
         Balancer.
        
         When ``active_request_bias > 0.0`` the Least Request Load Balancer scales the load balancing
         weight by the number of active requests at the time it does a pick.
        
         The value is cached for performance reasons and refreshed whenever one of the Load Balancer's
         host sets changes, e.g., whenever there is a host membership update or a host load balancing
         weight change.
        
         .. note::
         This setting only takes effect if all host weights are not equal.
         
        .envoy.config.core.v3.RuntimeDouble active_request_bias = 2;
      • hasSlowStartConfig

        boolean hasSlowStartConfig()
         Configuration for slow start mode.
         If this configuration is not set, slow start will not be not enabled.
         
        .envoy.extensions.load_balancing_policies.common.v3.SlowStartConfig slow_start_config = 3;
        Returns:
        Whether the slowStartConfig field is set.
      • getSlowStartConfig

        SlowStartConfig getSlowStartConfig()
         Configuration for slow start mode.
         If this configuration is not set, slow start will not be not enabled.
         
        .envoy.extensions.load_balancing_policies.common.v3.SlowStartConfig slow_start_config = 3;
        Returns:
        The slowStartConfig.
      • getSlowStartConfigOrBuilder

        SlowStartConfigOrBuilder getSlowStartConfigOrBuilder()
         Configuration for slow start mode.
         If this configuration is not set, slow start will not be not enabled.
         
        .envoy.extensions.load_balancing_policies.common.v3.SlowStartConfig slow_start_config = 3;
      • hasLocalityLbConfig

        boolean hasLocalityLbConfig()
         Configuration for local zone aware load balancing or locality weighted load balancing.
         
        .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig locality_lb_config = 4;
        Returns:
        Whether the localityLbConfig field is set.
      • getLocalityLbConfig

        LocalityLbConfig getLocalityLbConfig()
         Configuration for local zone aware load balancing or locality weighted load balancing.
         
        .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig locality_lb_config = 4;
        Returns:
        The localityLbConfig.
      • getLocalityLbConfigOrBuilder

        LocalityLbConfigOrBuilder getLocalityLbConfigOrBuilder()
         Configuration for local zone aware load balancing or locality weighted load balancing.
         
        .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig locality_lb_config = 4;
      • hasEnableFullScan

        @Deprecated
        boolean hasEnableFullScan()
        Deprecated.
        envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated. See envoy/extensions/load_balancing_policies/least_request/v3/least_request.proto;l=89
         [#not-implemented-hide:]
         Unused. Replaced by the `selection_method` enum for better extensibility.
         
        .google.protobuf.BoolValue enable_full_scan = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        Whether the enableFullScan field is set.
      • getEnableFullScan

        @Deprecated
        com.google.protobuf.BoolValue getEnableFullScan()
        Deprecated.
        envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated. See envoy/extensions/load_balancing_policies/least_request/v3/least_request.proto;l=89
         [#not-implemented-hide:]
         Unused. Replaced by the `selection_method` enum for better extensibility.
         
        .google.protobuf.BoolValue enable_full_scan = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The enableFullScan.
      • getEnableFullScanOrBuilder

        @Deprecated
        com.google.protobuf.BoolValueOrBuilder getEnableFullScanOrBuilder()
        Deprecated.
         [#not-implemented-hide:]
         Unused. Replaced by the `selection_method` enum for better extensibility.
         
        .google.protobuf.BoolValue enable_full_scan = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      • getSelectionMethodValue

        int getSelectionMethodValue()
         Method for selecting the host set from which to return the host with the fewest active requests.
        
         Defaults to ``N_CHOICES``.
         
        .envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.SelectionMethod selection_method = 6 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for selectionMethod.
      • getSelectionMethod

        LeastRequest.SelectionMethod getSelectionMethod()
         Method for selecting the host set from which to return the host with the fewest active requests.
        
         Defaults to ``N_CHOICES``.
         
        .envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.SelectionMethod selection_method = 6 [(.validate.rules) = { ... }
        Returns:
        The selectionMethod.