Class Cluster.RingHashLbConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.cluster.v3.Cluster.RingHashLbConfig
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cluster.RingHashLbConfigOrBuilder
,Serializable
- Enclosing class:
Cluster
public static final class Cluster.RingHashLbConfig
extends com.google.protobuf.GeneratedMessage
implements Cluster.RingHashLbConfigOrBuilder
Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>` load balancing policy.Protobuf type
envoy.config.cluster.v3.Cluster.RingHashLbConfig
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>` load balancing policy.static enum
The hash function used to hash hosts onto the ketama ring.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final Cluster.RingHashLbConfig
static final int
private int
static final int
private com.google.protobuf.UInt64Value
private byte
static final int
private com.google.protobuf.UInt64Value
private static final com.google.protobuf.Parser
<Cluster.RingHashLbConfig> private static final long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
RingHashLbConfig
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static Cluster.RingHashLbConfig
static final com.google.protobuf.Descriptors.Descriptor
The hash function used to hash hosts onto the ketama ring.int
The hash function used to hash hosts onto the ketama ring.com.google.protobuf.UInt64Value
Maximum hash ring size.com.google.protobuf.UInt64ValueOrBuilder
Maximum hash ring size.com.google.protobuf.UInt64Value
Minimum hash ring size.com.google.protobuf.UInt64ValueOrBuilder
Minimum hash ring size.com.google.protobuf.Parser
<Cluster.RingHashLbConfig> int
int
hashCode()
boolean
Maximum hash ring size.boolean
Minimum hash ring size.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilder
(Cluster.RingHashLbConfig prototype) protected Cluster.RingHashLbConfig.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static Cluster.RingHashLbConfig
parseDelimitedFrom
(InputStream input) static Cluster.RingHashLbConfig
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Cluster.RingHashLbConfig
parseFrom
(byte[] data) static Cluster.RingHashLbConfig
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Cluster.RingHashLbConfig
parseFrom
(com.google.protobuf.ByteString data) static Cluster.RingHashLbConfig
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Cluster.RingHashLbConfig
parseFrom
(com.google.protobuf.CodedInputStream input) static Cluster.RingHashLbConfig
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Cluster.RingHashLbConfig
parseFrom
(InputStream input) static Cluster.RingHashLbConfig
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Cluster.RingHashLbConfig
parseFrom
(ByteBuffer data) static Cluster.RingHashLbConfig
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<Cluster.RingHashLbConfig> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
MINIMUM_RING_SIZE_FIELD_NUMBER
public static final int MINIMUM_RING_SIZE_FIELD_NUMBER- See Also:
-
minimumRingSize_
private com.google.protobuf.UInt64Value minimumRingSize_ -
HASH_FUNCTION_FIELD_NUMBER
public static final int HASH_FUNCTION_FIELD_NUMBER- See Also:
-
hashFunction_
private int hashFunction_ -
MAXIMUM_RING_SIZE_FIELD_NUMBER
public static final int MAXIMUM_RING_SIZE_FIELD_NUMBER- See Also:
-
maximumRingSize_
private com.google.protobuf.UInt64Value maximumRingSize_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
RingHashLbConfig
private RingHashLbConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
RingHashLbConfig
private RingHashLbConfig()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
hasMinimumRingSize
public boolean hasMinimumRingSize()Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 1 [(.validate.rules) = { ... }
- Specified by:
hasMinimumRingSize
in interfaceCluster.RingHashLbConfigOrBuilder
- Returns:
- Whether the minimumRingSize field is set.
-
getMinimumRingSize
public com.google.protobuf.UInt64Value getMinimumRingSize()Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 1 [(.validate.rules) = { ... }
- Specified by:
getMinimumRingSize
in interfaceCluster.RingHashLbConfigOrBuilder
- Returns:
- The minimumRingSize.
-
getMinimumRingSizeOrBuilder
public com.google.protobuf.UInt64ValueOrBuilder getMinimumRingSizeOrBuilder()Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 1 [(.validate.rules) = { ... }
- Specified by:
getMinimumRingSizeOrBuilder
in interfaceCluster.RingHashLbConfigOrBuilder
-
getHashFunctionValue
public int getHashFunctionValue()The hash function used to hash hosts onto the ketama ring. The value defaults to :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
.envoy.config.cluster.v3.Cluster.RingHashLbConfig.HashFunction hash_function = 3 [(.validate.rules) = { ... }
- Specified by:
getHashFunctionValue
in interfaceCluster.RingHashLbConfigOrBuilder
- Returns:
- The enum numeric value on the wire for hashFunction.
-
getHashFunction
The hash function used to hash hosts onto the ketama ring. The value defaults to :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
.envoy.config.cluster.v3.Cluster.RingHashLbConfig.HashFunction hash_function = 3 [(.validate.rules) = { ... }
- Specified by:
getHashFunction
in interfaceCluster.RingHashLbConfigOrBuilder
- Returns:
- The hashFunction.
-
hasMaximumRingSize
public boolean hasMaximumRingSize()Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 4 [(.validate.rules) = { ... }
- Specified by:
hasMaximumRingSize
in interfaceCluster.RingHashLbConfigOrBuilder
- Returns:
- Whether the maximumRingSize field is set.
-
getMaximumRingSize
public com.google.protobuf.UInt64Value getMaximumRingSize()Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 4 [(.validate.rules) = { ... }
- Specified by:
getMaximumRingSize
in interfaceCluster.RingHashLbConfigOrBuilder
- Returns:
- The maximumRingSize.
-
getMaximumRingSizeOrBuilder
public com.google.protobuf.UInt64ValueOrBuilder getMaximumRingSizeOrBuilder()Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 4 [(.validate.rules) = { ... }
- Specified by:
getMaximumRingSizeOrBuilder
in interfaceCluster.RingHashLbConfigOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Cluster.RingHashLbConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Cluster.RingHashLbConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Cluster.RingHashLbConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-