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

Class SubClustersConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SubClustersConfigOrBuilder, Serializable
    public final class SubClustersConfig
extends com.google.protobuf.GeneratedMessageV3
implements SubClustersConfigOrBuilder
     Configuration for sub clusters. Hard code STRICT_DNS cluster type now.
    Protobuf type envoy.extensions.clusters.dynamic_forward_proxy.v3.SubClustersConfig
    See Also:
    Serialized Form

    • Field Detail

      • MAX_SUB_CLUSTERS_FIELD_NUMBER

        public static final int MAX_SUB_CLUSTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUB_CLUSTER_TTL_FIELD_NUMBER

        public static final int SUB_CLUSTER_TTL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRERESOLVE_CLUSTERS_FIELD_NUMBER

        public static final int PRERESOLVE_CLUSTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getLbPolicyValue

        public 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) = { ... }
        Specified by:
        getLbPolicyValue in interface SubClustersConfigOrBuilder
        Returns:
        The enum numeric value on the wire for lbPolicy.

      • getLbPolicy

        public 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) = { ... }
        Specified by:
        getLbPolicy in interface SubClustersConfigOrBuilder
        Returns:
        The lbPolicy.

      • hasMaxSubClusters

        public 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) = { ... }
        Specified by:
        hasMaxSubClusters in interface SubClustersConfigOrBuilder
        Returns:
        Whether the maxSubClusters field is set.

      • getMaxSubClusters

        public 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) = { ... }
        Specified by:
        getMaxSubClusters in interface SubClustersConfigOrBuilder
        Returns:
        The maxSubClusters.

      • getMaxSubClustersOrBuilder

        public 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) = { ... }
        Specified by:
        getMaxSubClustersOrBuilder in interface SubClustersConfigOrBuilder

      • hasSubClusterTtl

        public 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) = { ... }
        Specified by:
        hasSubClusterTtl in interface SubClustersConfigOrBuilder
        Returns:
        Whether the subClusterTtl field is set.

      • getSubClusterTtl

        public 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) = { ... }
        Specified by:
        getSubClusterTtl in interface SubClustersConfigOrBuilder
        Returns:
        The subClusterTtl.

      • getSubClusterTtlOrBuilder

        public 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) = { ... }
        Specified by:
        getSubClusterTtlOrBuilder in interface SubClustersConfigOrBuilder

      • getPreresolveClustersList

        public 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;
        Specified by:
        getPreresolveClustersList in interface SubClustersConfigOrBuilder

      • getPreresolveClustersOrBuilderList

        public 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;
        Specified by:
        getPreresolveClustersOrBuilderList in interface SubClustersConfigOrBuilder

      • getPreresolveClustersCount

        public 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;
        Specified by:
        getPreresolveClustersCount in interface SubClustersConfigOrBuilder

      • getPreresolveClusters

        public 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;
        Specified by:
        getPreresolveClusters in interface SubClustersConfigOrBuilder

      • getPreresolveClustersOrBuilder

        public 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;
        Specified by:
        getPreresolveClustersOrBuilder in interface SubClustersConfigOrBuilder

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(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 SubClustersConfig parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SubClustersConfig parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static SubClustersConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SubClustersConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SubClustersConfig> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public SubClustersConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder