Package io.envoyproxy.envoy.extensions.clusters.dynamic_forward_proxy.v3

Interface SubClustersConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SubClustersConfig, SubClustersConfig.Builder
public interface SubClustersConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Cluster.LbPolicy
    getLbPolicy()
    The :ref:`load balancer type <arch_overview_load_balancing_types>` to use when picking a host in a sub cluster.
    int
    getLbPolicyValue()
    The :ref:`load balancer type <arch_overview_load_balancing_types>` to use when picking a host in a sub cluster.
    com.google.protobuf.UInt32Value
    getMaxSubClusters()
    The maximum number of sub clusters that the DFP cluster will hold.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxSubClustersOrBuilder()
    The maximum number of sub clusters that the DFP cluster will hold.
    SocketAddress
    getPreresolveClusters(int index)
    Sub clusters that should be created & warmed upon creation.
    int
    getPreresolveClustersCount()
    Sub clusters that should be created & warmed upon creation.
    List<SocketAddress>
    getPreresolveClustersList()
    Sub clusters that should be created & warmed upon creation.
    SocketAddressOrBuilder
    getPreresolveClustersOrBuilder(int index)
    Sub clusters that should be created & warmed upon creation.
    List<? extends SocketAddressOrBuilder>
    getPreresolveClustersOrBuilderList()
    Sub clusters that should be created & warmed upon creation.
    com.google.protobuf.Duration
    getSubClusterTtl()
    The TTL for sub clusters that are unused.
    com.google.protobuf.DurationOrBuilder
    getSubClusterTtlOrBuilder()
    The TTL for sub clusters that are unused.
    boolean
    hasMaxSubClusters()
    The maximum number of sub clusters that the DFP cluster will hold.
    boolean
    hasSubClusterTtl()
    The TTL for sub clusters that are unused.

    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

    • getLbPolicyValue

      int getLbPolicyValue()
       The :ref:`load balancer type <arch_overview_load_balancing_types>` to use
 when picking a host in a sub cluster. Note that CLUSTER_PROVIDED is not allowed here.
      .envoy.config.cluster.v3.Cluster.LbPolicy lb_policy = 1 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for lbPolicy.

    • getLbPolicy

      Cluster.LbPolicy getLbPolicy()
       The :ref:`load balancer type <arch_overview_load_balancing_types>` to use
 when picking a host in a sub cluster. Note that CLUSTER_PROVIDED is not allowed here.
      .envoy.config.cluster.v3.Cluster.LbPolicy lb_policy = 1 [(.validate.rules) = { ... }
      Returns:
      The lbPolicy.

    • hasMaxSubClusters

      boolean hasMaxSubClusters()
       The maximum number of sub clusters that the DFP cluster will hold. If not specified defaults to 1024.
      .google.protobuf.UInt32Value max_sub_clusters = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the maxSubClusters field is set.

    • getMaxSubClusters

      com.google.protobuf.UInt32Value getMaxSubClusters()
       The maximum number of sub clusters that the DFP cluster will hold. If not specified defaults to 1024.
      .google.protobuf.UInt32Value max_sub_clusters = 2 [(.validate.rules) = { ... }
      Returns:
      The maxSubClusters.

    • getMaxSubClustersOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxSubClustersOrBuilder()
       The maximum number of sub clusters that the DFP cluster will hold. If not specified defaults to 1024.
      .google.protobuf.UInt32Value max_sub_clusters = 2 [(.validate.rules) = { ... }

    • hasSubClusterTtl

      boolean hasSubClusterTtl()
       The TTL for sub clusters that are unused. Sub clusters that have not been used in the configured time
 interval will be purged. If not specified defaults to 5m.
      .google.protobuf.Duration sub_cluster_ttl = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the subClusterTtl field is set.

    • getSubClusterTtl

      com.google.protobuf.Duration getSubClusterTtl()
       The TTL for sub clusters that are unused. Sub clusters that have not been used in the configured time
 interval will be purged. If not specified defaults to 5m.
      .google.protobuf.Duration sub_cluster_ttl = 3 [(.validate.rules) = { ... }
      Returns:
      The subClusterTtl.

    • getSubClusterTtlOrBuilder

      com.google.protobuf.DurationOrBuilder getSubClusterTtlOrBuilder()
       The TTL for sub clusters that are unused. Sub clusters that have not been used in the configured time
 interval will be purged. If not specified defaults to 5m.
      .google.protobuf.Duration sub_cluster_ttl = 3 [(.validate.rules) = { ... }

    • getPreresolveClustersList

      List<SocketAddress> getPreresolveClustersList()
       Sub clusters that should be created & warmed upon creation. This might provide a
 performance improvement, in the form of cache hits, for sub clusters that are going to be
 warmed during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_clusters = 4;

    • getPreresolveClusters

      SocketAddress getPreresolveClusters(int index)
       Sub clusters that should be created & warmed upon creation. This might provide a
 performance improvement, in the form of cache hits, for sub clusters that are going to be
 warmed during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_clusters = 4;

    • getPreresolveClustersCount

      int getPreresolveClustersCount()
       Sub clusters that should be created & warmed upon creation. This might provide a
 performance improvement, in the form of cache hits, for sub clusters that are going to be
 warmed during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_clusters = 4;

    • getPreresolveClustersOrBuilderList

      List<? extends SocketAddressOrBuilder> getPreresolveClustersOrBuilderList()
       Sub clusters that should be created & warmed upon creation. This might provide a
 performance improvement, in the form of cache hits, for sub clusters that are going to be
 warmed during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_clusters = 4;

    • getPreresolveClustersOrBuilder

      SocketAddressOrBuilder getPreresolveClustersOrBuilder(int index)
       Sub clusters that should be created & warmed upon creation. This might provide a
 performance improvement, in the form of cache hits, for sub clusters that are going to be
 warmed during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_clusters = 4;