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

Class ClusterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.clusters.composite.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 composite cluster. See the :ref:`architecture overview
 <arch_overview_composite_cluster>` for more information. This cluster type enables retry-aware
 cluster selection, allowing different retry attempts to automatically target
 different upstream clusters. Unlike the standard aggregate cluster which uses
 health-based selection, the composite cluster uses the retry attempt count to
 deterministically select which sub-cluster to route to.

 When retry attempts exceed the number of configured clusters, requests will fail with no
 host available.

 Example configuration:

 .. code-block:: yaml

     name: composite_cluster
     connect_timeout: 0.25s
     lb_policy: CLUSTER_PROVIDED
     cluster_type:
       name: envoy.clusters.composite
       typed_config:
         "@type": type.googleapis.com/envoy.extensions.clusters.composite.v3.ClusterConfig
         clusters:
         - name: primary_cluster
         - name: secondary_cluster
         - name: fallback_cluster

 [#extension: envoy.clusters.composite]
Protobuf type envoy.extensions.clusters.composite.v3.ClusterConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ClusterConfig.Builder
    Configuration for the composite cluster.
    static final class 
    ClusterConfig.ClusterEntry
    Configuration for an individual cluster entry.
    static interface 
    ClusterConfig.ClusterEntryOrBuilder
     

    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
    CLUSTERS_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)
     
    ClusterConfig.ClusterEntry
    getClusters(int index)
    List of clusters to use for request routing.
    int
    getClustersCount()
    List of clusters to use for request routing.
    List<ClusterConfig.ClusterEntry>
    getClustersList()
    List of clusters to use for request routing.
    ClusterConfig.ClusterEntryOrBuilder
    getClustersOrBuilder(int index)
    List of clusters to use for request routing.
    List<? extends ClusterConfig.ClusterEntryOrBuilder>
    getClustersOrBuilderList()
    List of clusters to use for request routing.
    static ClusterConfig
    getDefaultInstance()
     
    ClusterConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<ClusterConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    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

  • 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

    • getClustersList

      public List<ClusterConfig.ClusterEntry> getClustersList()
       List of clusters to use for request routing. The first cluster is used for the
 initial request (attempt 1), the second cluster for the first retry (attempt 2),
 and so on. Must contain at least one cluster. When retry attempts exceed the number
 of configured clusters, requests will fail with no host available.
      repeated .envoy.extensions.clusters.composite.v3.ClusterConfig.ClusterEntry clusters = 1 [(.validate.rules) = { ... }
      Specified by:
      getClustersList in interface ClusterConfigOrBuilder

    • getClustersOrBuilderList

      public List<? extends ClusterConfig.ClusterEntryOrBuilder> getClustersOrBuilderList()
       List of clusters to use for request routing. The first cluster is used for the
 initial request (attempt 1), the second cluster for the first retry (attempt 2),
 and so on. Must contain at least one cluster. When retry attempts exceed the number
 of configured clusters, requests will fail with no host available.
      repeated .envoy.extensions.clusters.composite.v3.ClusterConfig.ClusterEntry clusters = 1 [(.validate.rules) = { ... }
      Specified by:
      getClustersOrBuilderList in interface ClusterConfigOrBuilder

    • getClustersCount

      public int getClustersCount()
       List of clusters to use for request routing. The first cluster is used for the
 initial request (attempt 1), the second cluster for the first retry (attempt 2),
 and so on. Must contain at least one cluster. When retry attempts exceed the number
 of configured clusters, requests will fail with no host available.
      repeated .envoy.extensions.clusters.composite.v3.ClusterConfig.ClusterEntry clusters = 1 [(.validate.rules) = { ... }
      Specified by:
      getClustersCount in interface ClusterConfigOrBuilder

    • getClusters

      public ClusterConfig.ClusterEntry getClusters(int index)
       List of clusters to use for request routing. The first cluster is used for the
 initial request (attempt 1), the second cluster for the first retry (attempt 2),
 and so on. Must contain at least one cluster. When retry attempts exceed the number
 of configured clusters, requests will fail with no host available.
      repeated .envoy.extensions.clusters.composite.v3.ClusterConfig.ClusterEntry clusters = 1 [(.validate.rules) = { ... }
      Specified by:
      getClusters in interface ClusterConfigOrBuilder

    • getClustersOrBuilder

      public ClusterConfig.ClusterEntryOrBuilder getClustersOrBuilder(int index)
       List of clusters to use for request routing. The first cluster is used for the
 initial request (attempt 1), the second cluster for the first retry (attempt 2),
 and so on. Must contain at least one cluster. When retry attempts exceed the number
 of configured clusters, requests will fail with no host available.
      repeated .envoy.extensions.clusters.composite.v3.ClusterConfig.ClusterEntry clusters = 1 [(.validate.rules) = { ... }
      Specified by:
      getClustersOrBuilder in interface ClusterConfigOrBuilder

    • 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