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

Class SubClustersConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.clusters.dynamic_forward_proxy.v3.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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SubClustersConfig.Builder
    Configuration for sub clusters.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LB_POLICY_FIELD_NUMBER
     
    static final int
    MAX_SUB_CLUSTERS_FIELD_NUMBER
     
    static final int
    PRERESOLVE_CLUSTERS_FIELD_NUMBER
     
    static final int
    SUB_CLUSTER_TTL_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SubClustersConfig
    getDefaultInstance()
     
    SubClustersConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<SubClustersConfig>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    boolean
    hasMaxSubClusters()
    The maximum number of sub clusters that the DFP cluster will hold.
    boolean
    hasSubClusterTtl()
    The TTL for sub clusters that are unused.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SubClustersConfig.Builder
    newBuilder()
     
    static SubClustersConfig.Builder
    newBuilder(SubClustersConfig prototype)
     
    SubClustersConfig.Builder
    newBuilderForType()
     
    protected SubClustersConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SubClustersConfig
    parseDelimitedFrom(InputStream input)
     
    static SubClustersConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubClustersConfig
    parseFrom(byte[] data)
     
    static SubClustersConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubClustersConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static SubClustersConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubClustersConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SubClustersConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubClustersConfig
    parseFrom(InputStream input)
     
    static SubClustersConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SubClustersConfig
    parseFrom(ByteBuffer data)
     
    static SubClustersConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SubClustersConfig>
    parser()
     
    SubClustersConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • LB_POLICY_FIELD_NUMBER

      public static final int LB_POLICY_FIELD_NUMBER
      See Also:

    • MAX_SUB_CLUSTERS_FIELD_NUMBER

      public static final int MAX_SUB_CLUSTERS_FIELD_NUMBER
      See Also:

    • SUB_CLUSTER_TTL_FIELD_NUMBER

      public static final int SUB_CLUSTER_TTL_FIELD_NUMBER
      See Also:

    • PRERESOLVE_CLUSTERS_FIELD_NUMBER

      public static final int PRERESOLVE_CLUSTERS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SubClustersConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SubClustersConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static SubClustersConfig.Builder newBuilder()

    • newBuilder

      public static SubClustersConfig.Builder newBuilder(SubClustersConfig prototype)

    • 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

    • getDefaultInstance

      public static SubClustersConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SubClustersConfig> parser()

    • 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