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

Class Maglev

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.load_balancing_policies.maglev.v3.Maglev
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MaglevOrBuilder, Serializable
public final class Maglev extends com.google.protobuf.GeneratedMessageV3 implements MaglevOrBuilder
 This configuration allows the built-in Maglev LB policy to be configured via the LB policy
 extension point. See the :ref:`load balancing architecture overview
 <arch_overview_load_balancing_types>` and :ref:`Maglev<arch_overview_load_balancing_types_maglev>` for more information.
Protobuf type envoy.extensions.load_balancing_policies.maglev.v3.Maglev
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Maglev.Builder
    This configuration allows the built-in Maglev LB policy to be configured via the LB policy extension point.

    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
    CONSISTENT_HASHING_LB_CONFIG_FIELD_NUMBER
     
    static final int
    LOCALITY_WEIGHTED_LB_CONFIG_FIELD_NUMBER
     
    static final int
    TABLE_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)
     
    ConsistentHashingLbConfig
    getConsistentHashingLbConfig()
    Common configuration for hashing-based load balancing policies.
    ConsistentHashingLbConfigOrBuilder
    getConsistentHashingLbConfigOrBuilder()
    Common configuration for hashing-based load balancing policies.
    static Maglev
    getDefaultInstance()
     
    Maglev
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    LocalityLbConfig.LocalityWeightedLbConfig
    getLocalityWeightedLbConfig()
    Enable locality weighted load balancing for maglev lb explicitly.
    LocalityLbConfig.LocalityWeightedLbConfigOrBuilder
    getLocalityWeightedLbConfigOrBuilder()
    Enable locality weighted load balancing for maglev lb explicitly.
    com.google.protobuf.Parser<Maglev>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.UInt64Value
    getTableSize()
    The table size for Maglev hashing.
    com.google.protobuf.UInt64ValueOrBuilder
    getTableSizeOrBuilder()
    The table size for Maglev hashing.
    boolean
    hasConsistentHashingLbConfig()
    Common configuration for hashing-based load balancing policies.
    int
    hashCode()
     
    boolean
    hasLocalityWeightedLbConfig()
    Enable locality weighted load balancing for maglev lb explicitly.
    boolean
    hasTableSize()
    The table size for Maglev hashing.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Maglev.Builder
    newBuilder()
     
    static Maglev.Builder
    newBuilder(Maglev prototype)
     
    Maglev.Builder
    newBuilderForType()
     
    protected Maglev.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Maglev
    parseDelimitedFrom(InputStream input)
     
    static Maglev
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Maglev
    parseFrom(byte[] data)
     
    static Maglev
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Maglev
    parseFrom(com.google.protobuf.ByteString data)
     
    static Maglev
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Maglev
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Maglev
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Maglev
    parseFrom(InputStream input)
     
    static Maglev
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Maglev
    parseFrom(ByteBuffer data)
     
    static Maglev
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Maglev>
    parser()
     
    Maglev.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

    • TABLE_SIZE_FIELD_NUMBER

      public static final int TABLE_SIZE_FIELD_NUMBER
      See Also:

    • CONSISTENT_HASHING_LB_CONFIG_FIELD_NUMBER

      public static final int CONSISTENT_HASHING_LB_CONFIG_FIELD_NUMBER
      See Also:

    • LOCALITY_WEIGHTED_LB_CONFIG_FIELD_NUMBER

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

    • hasTableSize

      public boolean hasTableSize()
       The table size for Maglev hashing. Maglev aims for "minimal disruption" rather than an absolute guarantee.
 Minimal disruption means that when the set of upstream hosts change, a connection will likely be sent to the same
 upstream as it was before. Increasing the table size reduces the amount of disruption.
 The table size must be prime number limited to 5000011. If it is not specified, the default is 65537.
      .google.protobuf.UInt64Value table_size = 1 [(.validate.rules) = { ... }
      Specified by:
      hasTableSize in interface MaglevOrBuilder
      Returns:
      Whether the tableSize field is set.

    • getTableSize

      public com.google.protobuf.UInt64Value getTableSize()
       The table size for Maglev hashing. Maglev aims for "minimal disruption" rather than an absolute guarantee.
 Minimal disruption means that when the set of upstream hosts change, a connection will likely be sent to the same
 upstream as it was before. Increasing the table size reduces the amount of disruption.
 The table size must be prime number limited to 5000011. If it is not specified, the default is 65537.
      .google.protobuf.UInt64Value table_size = 1 [(.validate.rules) = { ... }
      Specified by:
      getTableSize in interface MaglevOrBuilder
      Returns:
      The tableSize.

    • getTableSizeOrBuilder

      public com.google.protobuf.UInt64ValueOrBuilder getTableSizeOrBuilder()
       The table size for Maglev hashing. Maglev aims for "minimal disruption" rather than an absolute guarantee.
 Minimal disruption means that when the set of upstream hosts change, a connection will likely be sent to the same
 upstream as it was before. Increasing the table size reduces the amount of disruption.
 The table size must be prime number limited to 5000011. If it is not specified, the default is 65537.
      .google.protobuf.UInt64Value table_size = 1 [(.validate.rules) = { ... }
      Specified by:
      getTableSizeOrBuilder in interface MaglevOrBuilder

    • hasConsistentHashingLbConfig

      public boolean hasConsistentHashingLbConfig()
       Common configuration for hashing-based load balancing policies.
      .envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 2;
      Specified by:
      hasConsistentHashingLbConfig in interface MaglevOrBuilder
      Returns:
      Whether the consistentHashingLbConfig field is set.

    • getConsistentHashingLbConfig

      public ConsistentHashingLbConfig getConsistentHashingLbConfig()
       Common configuration for hashing-based load balancing policies.
      .envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 2;
      Specified by:
      getConsistentHashingLbConfig in interface MaglevOrBuilder
      Returns:
      The consistentHashingLbConfig.

    • getConsistentHashingLbConfigOrBuilder

      public ConsistentHashingLbConfigOrBuilder getConsistentHashingLbConfigOrBuilder()
       Common configuration for hashing-based load balancing policies.
      .envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 2;
      Specified by:
      getConsistentHashingLbConfigOrBuilder in interface MaglevOrBuilder

    • hasLocalityWeightedLbConfig

      public boolean hasLocalityWeightedLbConfig()
       Enable locality weighted load balancing for maglev lb explicitly.
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;
      Specified by:
      hasLocalityWeightedLbConfig in interface MaglevOrBuilder
      Returns:
      Whether the localityWeightedLbConfig field is set.

    • getLocalityWeightedLbConfig

      public LocalityLbConfig.LocalityWeightedLbConfig getLocalityWeightedLbConfig()
       Enable locality weighted load balancing for maglev lb explicitly.
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;
      Specified by:
      getLocalityWeightedLbConfig in interface MaglevOrBuilder
      Returns:
      The localityWeightedLbConfig.

    • getLocalityWeightedLbConfigOrBuilder

      public LocalityLbConfig.LocalityWeightedLbConfigOrBuilder getLocalityWeightedLbConfigOrBuilder()
       Enable locality weighted load balancing for maglev lb explicitly.
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;
      Specified by:
      getLocalityWeightedLbConfigOrBuilder in interface MaglevOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Maglev.Builder newBuilder()

    • newBuilder

      public static Maglev.Builder newBuilder(Maglev prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Maglev getDefaultInstance()

    • parser

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

    • getParserForType

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