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

Class ClusterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.clusters.dynamic_forward_proxy.v3.ClusterConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClusterConfigOrBuilder, Serializable
public final class ClusterConfig extends com.google.protobuf.GeneratedMessageV3 implements ClusterConfigOrBuilder
 Configuration for the dynamic forward proxy cluster. See the :ref:`architecture overview
 <arch_overview_http_dynamic_forward_proxy>` for more information.
 [#extension: envoy.clusters.dynamic_forward_proxy]
Protobuf type envoy.extensions.clusters.dynamic_forward_proxy.v3.ClusterConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ClusterConfig.Builder
    Configuration for the dynamic forward proxy cluster.
    static enum 
    ClusterConfig.ClusterImplementationSpecifierCase
     

    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
    ALLOW_COALESCED_CONNECTIONS_FIELD_NUMBER
     
    static final int
    ALLOW_INSECURE_CLUSTER_OPTIONS_FIELD_NUMBER
     
    static final int
    DNS_CACHE_CONFIG_FIELD_NUMBER
     
    static final int
    SUB_CLUSTERS_CONFIG_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)
     
    boolean
    getAllowCoalescedConnections()
    If true allow HTTP/2 and HTTP/3 connections to be reused for requests to different origins than the connection was initially created for.
    boolean
    getAllowInsecureClusterOptions()
    If true allow the cluster configuration to disable the auto_sni and auto_san_validation options in the :ref:`cluster's upstream_http_protocol_options <envoy_v3_api_field_config.cluster.v3.Cluster.upstream_http_protocol_options>`
    ClusterConfig.ClusterImplementationSpecifierCase
    getClusterImplementationSpecifierCase()
     
    static ClusterConfig
    getDefaultInstance()
     
    ClusterConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DnsCacheConfig
    getDnsCacheConfig()
    The DNS cache configuration that the cluster will attach to.
    DnsCacheConfigOrBuilder
    getDnsCacheConfigOrBuilder()
    The DNS cache configuration that the cluster will attach to.
    com.google.protobuf.Parser<ClusterConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    SubClustersConfig
    getSubClustersConfig()
    Configuration for sub clusters, when this configuration is enabled, Envoy will create an independent sub cluster dynamically for each host:port.
    SubClustersConfigOrBuilder
    getSubClustersConfigOrBuilder()
    Configuration for sub clusters, when this configuration is enabled, Envoy will create an independent sub cluster dynamically for each host:port.
    boolean
    hasDnsCacheConfig()
    The DNS cache configuration that the cluster will attach to.
    int
    hashCode()
     
    boolean
    hasSubClustersConfig()
    Configuration for sub clusters, when this configuration is enabled, Envoy will create an independent sub cluster dynamically for each host:port.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ClusterConfig.Builder
    newBuilder()
     
    static ClusterConfig.Builder
    newBuilder(ClusterConfig prototype)
     
    ClusterConfig.Builder
    newBuilderForType()
     
    protected ClusterConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ClusterConfig
    parseDelimitedFrom(InputStream input)
     
    static ClusterConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClusterConfig
    parseFrom(byte[] data)
     
    static ClusterConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClusterConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static ClusterConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClusterConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ClusterConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClusterConfig
    parseFrom(InputStream input)
     
    static ClusterConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClusterConfig
    parseFrom(ByteBuffer data)
     
    static ClusterConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ClusterConfig>
    parser()
     
    ClusterConfig.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

    • DNS_CACHE_CONFIG_FIELD_NUMBER

      public static final int DNS_CACHE_CONFIG_FIELD_NUMBER
      See Also:

    • SUB_CLUSTERS_CONFIG_FIELD_NUMBER

      public static final int SUB_CLUSTERS_CONFIG_FIELD_NUMBER
      See Also:

    • ALLOW_INSECURE_CLUSTER_OPTIONS_FIELD_NUMBER

      public static final int ALLOW_INSECURE_CLUSTER_OPTIONS_FIELD_NUMBER
      See Also:

    • ALLOW_COALESCED_CONNECTIONS_FIELD_NUMBER

      public static final int ALLOW_COALESCED_CONNECTIONS_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

    • getClusterImplementationSpecifierCase

      public ClusterConfig.ClusterImplementationSpecifierCase getClusterImplementationSpecifierCase()
      Specified by:
      getClusterImplementationSpecifierCase in interface ClusterConfigOrBuilder

    • hasDnsCacheConfig

      public boolean hasDnsCacheConfig()
       The DNS cache configuration that the cluster will attach to. Note this configuration must
 match that of associated :ref:`dynamic forward proxy HTTP filter configuration
 <envoy_v3_api_field_extensions.filters.http.dynamic_forward_proxy.v3.FilterConfig.dns_cache_config>`.
      .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig dns_cache_config = 1;
      Specified by:
      hasDnsCacheConfig in interface ClusterConfigOrBuilder
      Returns:
      Whether the dnsCacheConfig field is set.

    • getDnsCacheConfig

      public DnsCacheConfig getDnsCacheConfig()
       The DNS cache configuration that the cluster will attach to. Note this configuration must
 match that of associated :ref:`dynamic forward proxy HTTP filter configuration
 <envoy_v3_api_field_extensions.filters.http.dynamic_forward_proxy.v3.FilterConfig.dns_cache_config>`.
      .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig dns_cache_config = 1;
      Specified by:
      getDnsCacheConfig in interface ClusterConfigOrBuilder
      Returns:
      The dnsCacheConfig.

    • getDnsCacheConfigOrBuilder

      public DnsCacheConfigOrBuilder getDnsCacheConfigOrBuilder()
       The DNS cache configuration that the cluster will attach to. Note this configuration must
 match that of associated :ref:`dynamic forward proxy HTTP filter configuration
 <envoy_v3_api_field_extensions.filters.http.dynamic_forward_proxy.v3.FilterConfig.dns_cache_config>`.
      .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig dns_cache_config = 1;
      Specified by:
      getDnsCacheConfigOrBuilder in interface ClusterConfigOrBuilder

    • hasSubClustersConfig

      public boolean hasSubClustersConfig()
       Configuration for sub clusters, when this configuration is enabled,
 Envoy will create an independent sub cluster dynamically for each host:port.
 Most of the configuration of a sub cluster is inherited from the current cluster,
 i.e. health_checks, dns_resolvers and etc.
 And the load_assignment will be set to the only one endpoint, host:port.

 Compared to the dns_cache_config, it has the following advantages:

 1. sub clusters will be created with the STRICT_DNS DiscoveryType,
    so that Envoy will use all of the IPs resolved from the host.

 2. each sub cluster is full featured cluster, with lb_policy and health check and etc enabled.
      .envoy.extensions.clusters.dynamic_forward_proxy.v3.SubClustersConfig sub_clusters_config = 4;
      Specified by:
      hasSubClustersConfig in interface ClusterConfigOrBuilder
      Returns:
      Whether the subClustersConfig field is set.

    • getSubClustersConfig

      public SubClustersConfig getSubClustersConfig()
       Configuration for sub clusters, when this configuration is enabled,
 Envoy will create an independent sub cluster dynamically for each host:port.
 Most of the configuration of a sub cluster is inherited from the current cluster,
 i.e. health_checks, dns_resolvers and etc.
 And the load_assignment will be set to the only one endpoint, host:port.

 Compared to the dns_cache_config, it has the following advantages:

 1. sub clusters will be created with the STRICT_DNS DiscoveryType,
    so that Envoy will use all of the IPs resolved from the host.

 2. each sub cluster is full featured cluster, with lb_policy and health check and etc enabled.
      .envoy.extensions.clusters.dynamic_forward_proxy.v3.SubClustersConfig sub_clusters_config = 4;
      Specified by:
      getSubClustersConfig in interface ClusterConfigOrBuilder
      Returns:
      The subClustersConfig.

    • getSubClustersConfigOrBuilder

      public SubClustersConfigOrBuilder getSubClustersConfigOrBuilder()
       Configuration for sub clusters, when this configuration is enabled,
 Envoy will create an independent sub cluster dynamically for each host:port.
 Most of the configuration of a sub cluster is inherited from the current cluster,
 i.e. health_checks, dns_resolvers and etc.
 And the load_assignment will be set to the only one endpoint, host:port.

 Compared to the dns_cache_config, it has the following advantages:

 1. sub clusters will be created with the STRICT_DNS DiscoveryType,
    so that Envoy will use all of the IPs resolved from the host.

 2. each sub cluster is full featured cluster, with lb_policy and health check and etc enabled.
      .envoy.extensions.clusters.dynamic_forward_proxy.v3.SubClustersConfig sub_clusters_config = 4;
      Specified by:
      getSubClustersConfigOrBuilder in interface ClusterConfigOrBuilder

    • getAllowInsecureClusterOptions

      public boolean getAllowInsecureClusterOptions()
       If true allow the cluster configuration to disable the auto_sni and auto_san_validation options
 in the :ref:`cluster's upstream_http_protocol_options
 <envoy_v3_api_field_config.cluster.v3.Cluster.upstream_http_protocol_options>`
      bool allow_insecure_cluster_options = 2;
      Specified by:
      getAllowInsecureClusterOptions in interface ClusterConfigOrBuilder
      Returns:
      The allowInsecureClusterOptions.

    • getAllowCoalescedConnections

      public boolean getAllowCoalescedConnections()
       If true allow HTTP/2 and HTTP/3 connections to be reused for requests to different
 origins than the connection was initially created for. This will only happen when the
 resolved address for the new connection matches the peer address of the connection and
 the TLS certificate is also valid for the new hostname. For example, if a connection
 has previously been established to foo.example.com at IP 1.2.3.4 with a certificate
 that is valid for ``*.example.com``, then this connection could be used for requests to
 bar.example.com if that also resolved to 1.2.3.4.

 .. note::
   By design, this feature will maximize reuse of connections. This means that instead
   opening a new connection when an existing connection reaches the maximum number of
   concurrent streams, requests will instead be sent to the existing connection.

 .. note::
   The coalesced connections might be to upstreams that would not be otherwise
   selected by Envoy. See the section `Connection Reuse in RFC 7540
   <https://datatracker.ietf.org/doc/html/rfc7540#section-9.1.1>`_
      bool allow_coalesced_connections = 3;
      Specified by:
      getAllowCoalescedConnections in interface ClusterConfigOrBuilder
      Returns:
      The allowCoalescedConnections.

    • 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 ClusterConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ClusterConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ClusterConfig.Builder newBuilder()

    • newBuilder

      public static ClusterConfig.Builder newBuilder(ClusterConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ClusterConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ClusterConfig> 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 ClusterConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder