Package io.envoyproxy.envoy.extensions.load_balancing_policies.random_subsetting.v3

Class RandomSubsetting

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.load_balancing_policies.random_subsetting.v3.RandomSubsetting
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RandomSubsettingOrBuilder, Serializable
public final class RandomSubsetting extends com.google.protobuf.GeneratedMessageV3 implements RandomSubsettingOrBuilder
 Configuration for the Random Subsetting Load Balancing Policy

 This policy selects a subset of endpoints and passes them to the child LB policy.
 It maintains 2 important properties:
 1. The policy tries to distribute connections among servers as equally as possible. The higher
 ``(N_clients*subset_size)/N_servers`` ratio is, the closer the resulting server connection
 distribution is to uniform.
 2. The policy minimizes the amount of connection churn generated during server scale-ups by
 using rendezvous hashing

 See the :ref:`load balancing architecture
 overview<arch_overview_load_balancing_types>` for more information.

 [#not-implemented-hide:]
Protobuf type envoy.extensions.load_balancing_policies.random_subsetting.v3.RandomSubsetting
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RandomSubsetting.Builder
    Configuration for the Random Subsetting Load Balancing Policy This policy selects a subset of endpoints and passes them to the child LB policy.

    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
    CHILD_POLICY_FIELD_NUMBER
     
    static final int
    SUBSET_SIZE_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)
     
    LoadBalancingPolicy
    getChildPolicy()
    The config for the child policy.
    LoadBalancingPolicyOrBuilder
    getChildPolicyOrBuilder()
    The config for the child policy.
    static RandomSubsetting
    getDefaultInstance()
     
    RandomSubsetting
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<RandomSubsetting>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.UInt32Value
    getSubsetSize()
    subset_size indicates how many backends every client will be connected to.
    com.google.protobuf.UInt32ValueOrBuilder
    getSubsetSizeOrBuilder()
    subset_size indicates how many backends every client will be connected to.
    boolean
    hasChildPolicy()
    The config for the child policy.
    int
    hashCode()
     
    boolean
    hasSubsetSize()
    subset_size indicates how many backends every client will be connected to.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RandomSubsetting.Builder
    newBuilder()
     
    static RandomSubsetting.Builder
    newBuilder(RandomSubsetting prototype)
     
    RandomSubsetting.Builder
    newBuilderForType()
     
    protected RandomSubsetting.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RandomSubsetting
    parseDelimitedFrom(InputStream input)
     
    static RandomSubsetting
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RandomSubsetting
    parseFrom(byte[] data)
     
    static RandomSubsetting
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RandomSubsetting
    parseFrom(com.google.protobuf.ByteString data)
     
    static RandomSubsetting
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RandomSubsetting
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RandomSubsetting
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RandomSubsetting
    parseFrom(InputStream input)
     
    static RandomSubsetting
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RandomSubsetting
    parseFrom(ByteBuffer data)
     
    static RandomSubsetting
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RandomSubsetting>
    parser()
     
    RandomSubsetting.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

    • SUBSET_SIZE_FIELD_NUMBER

      public static final int SUBSET_SIZE_FIELD_NUMBER
      See Also:

    • CHILD_POLICY_FIELD_NUMBER

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

    • hasSubsetSize

      public boolean hasSubsetSize()
       subset_size indicates how many backends every client will be connected to.
 The value must be greater than 0.
      .google.protobuf.UInt32Value subset_size = 1 [(.validate.rules) = { ... }
      Specified by:
      hasSubsetSize in interface RandomSubsettingOrBuilder
      Returns:
      Whether the subsetSize field is set.

    • getSubsetSize

      public com.google.protobuf.UInt32Value getSubsetSize()
       subset_size indicates how many backends every client will be connected to.
 The value must be greater than 0.
      .google.protobuf.UInt32Value subset_size = 1 [(.validate.rules) = { ... }
      Specified by:
      getSubsetSize in interface RandomSubsettingOrBuilder
      Returns:
      The subsetSize.

    • getSubsetSizeOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getSubsetSizeOrBuilder()
       subset_size indicates how many backends every client will be connected to.
 The value must be greater than 0.
      .google.protobuf.UInt32Value subset_size = 1 [(.validate.rules) = { ... }
      Specified by:
      getSubsetSizeOrBuilder in interface RandomSubsettingOrBuilder

    • hasChildPolicy

      public boolean hasChildPolicy()
       The config for the child policy.
 The value is required.
      .envoy.config.cluster.v3.LoadBalancingPolicy child_policy = 2 [(.validate.rules) = { ... }
      Specified by:
      hasChildPolicy in interface RandomSubsettingOrBuilder
      Returns:
      Whether the childPolicy field is set.

    • getChildPolicy

      public LoadBalancingPolicy getChildPolicy()
       The config for the child policy.
 The value is required.
      .envoy.config.cluster.v3.LoadBalancingPolicy child_policy = 2 [(.validate.rules) = { ... }
      Specified by:
      getChildPolicy in interface RandomSubsettingOrBuilder
      Returns:
      The childPolicy.

    • getChildPolicyOrBuilder

      public LoadBalancingPolicyOrBuilder getChildPolicyOrBuilder()
       The config for the child policy.
 The value is required.
      .envoy.config.cluster.v3.LoadBalancingPolicy child_policy = 2 [(.validate.rules) = { ... }
      Specified by:
      getChildPolicyOrBuilder in interface RandomSubsettingOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RandomSubsetting.Builder newBuilder()

    • newBuilder

      public static RandomSubsetting.Builder newBuilder(RandomSubsetting prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RandomSubsetting getDefaultInstance()

    • parser

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

    • getParserForType

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