io.envoyproxy.envoy.api.v2

Class Cluster.RingHashLbConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.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.GeneratedMessageV3
implements Cluster.RingHashLbConfigOrBuilder

 Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>`
 load balancing policy.
 

Protobuf type envoy.api.v2.Cluster.RingHashLbConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.RingHashLbConfig.Builder Specific configuration for the :ref:`RingHash<arch_overview_load_balancing_types_ring_hash>` load balancing policy.
static class	Cluster.RingHashLbConfig.DeprecatedV1 [#not-implemented-hide:] Hide from docs.
static interface	Cluster.RingHashLbConfig.DeprecatedV1OrBuilder
static class	Cluster.RingHashLbConfig.HashFunction The hash function used to hash hosts onto the ketama ring.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEPRECATED_V1_FIELD_NUMBER
static int	HASH_FUNCTION_FIELD_NUMBER
static int	MINIMUM_RING_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 and Description
boolean	equals(Object obj)
static Cluster.RingHashLbConfig	getDefaultInstance()
Cluster.RingHashLbConfig	getDefaultInstanceForType()
Cluster.RingHashLbConfig.DeprecatedV1	getDeprecatedV1() Deprecated.
Cluster.RingHashLbConfig.DeprecatedV1OrBuilder	getDeprecatedV1OrBuilder() Deprecated.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Cluster.RingHashLbConfig.HashFunction	getHashFunction() The hash function used to hash hosts onto the ketama ring.
int	getHashFunctionValue() The hash function used to hash hosts onto the ketama ring.
com.google.protobuf.UInt64Value	getMinimumRingSize() Minimum hash ring size, i.e. total virtual nodes.
com.google.protobuf.UInt64ValueOrBuilder	getMinimumRingSizeOrBuilder() Minimum hash ring size, i.e. total virtual nodes.
com.google.protobuf.Parser<Cluster.RingHashLbConfig>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDeprecatedV1() Deprecated.
int	hashCode()
boolean	hasMinimumRingSize() Minimum hash ring size, i.e. total virtual nodes.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Cluster.RingHashLbConfig.Builder	newBuilder()
static Cluster.RingHashLbConfig.Builder	newBuilder(Cluster.RingHashLbConfig prototype)
Cluster.RingHashLbConfig.Builder	newBuilderForType()
protected Cluster.RingHashLbConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.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(ByteBuffer data)
static Cluster.RingHashLbConfig	parseFrom(ByteBuffer 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 com.google.protobuf.Parser<Cluster.RingHashLbConfig>	parser()
Cluster.RingHashLbConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MINIMUM_RING_SIZE_FIELD_NUMBER

public static final int MINIMUM_RING_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

DEPRECATED_V1_FIELD_NUMBER

public static final int DEPRECATED_V1_FIELD_NUMBER

See Also:

Constant Field Values

HASH_FUNCTION_FIELD_NUMBER

public static final int HASH_FUNCTION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

hasMinimumRingSize

public boolean hasMinimumRingSize()

 Minimum hash ring size, i.e. total virtual nodes. A larger size
 will provide better request distribution since each host in the
 cluster will have more virtual nodes. Defaults to 1024. In the case
 that total number of hosts is greater than the minimum, each host will
 be allocated a single virtual node. This field is limited to 8M to bound
 resource use.
 

.google.protobuf.UInt64Value minimum_ring_size = 1 [(.validate.rules) = { ... }

Specified by:

hasMinimumRingSize in interface Cluster.RingHashLbConfigOrBuilder

getMinimumRingSize

public com.google.protobuf.UInt64Value getMinimumRingSize()

 Minimum hash ring size, i.e. total virtual nodes. A larger size
 will provide better request distribution since each host in the
 cluster will have more virtual nodes. Defaults to 1024. In the case
 that total number of hosts is greater than the minimum, each host will
 be allocated a single virtual node. This field is limited to 8M to bound
 resource use.
 

.google.protobuf.UInt64Value minimum_ring_size = 1 [(.validate.rules) = { ... }

Specified by:

getMinimumRingSize in interface Cluster.RingHashLbConfigOrBuilder

getMinimumRingSizeOrBuilder

public com.google.protobuf.UInt64ValueOrBuilder getMinimumRingSizeOrBuilder()

 Minimum hash ring size, i.e. total virtual nodes. A larger size
 will provide better request distribution since each host in the
 cluster will have more virtual nodes. Defaults to 1024. In the case
 that total number of hosts is greater than the minimum, each host will
 be allocated a single virtual node. This field is limited to 8M to bound
 resource use.
 

.google.protobuf.UInt64Value minimum_ring_size = 1 [(.validate.rules) = { ... }

Specified by:

getMinimumRingSizeOrBuilder in interface Cluster.RingHashLbConfigOrBuilder

hasDeprecatedV1

@Deprecated
public boolean hasDeprecatedV1()

Deprecated.

 Deprecated settings from v1 config.
 [#not-implemented-hide:] Hide from docs.
 

.envoy.api.v2.Cluster.RingHashLbConfig.DeprecatedV1 deprecated_v1 = 2 [deprecated = true];

Specified by:

hasDeprecatedV1 in interface Cluster.RingHashLbConfigOrBuilder

getDeprecatedV1

@Deprecated
public Cluster.RingHashLbConfig.DeprecatedV1 getDeprecatedV1()

Deprecated.

 Deprecated settings from v1 config.
 [#not-implemented-hide:] Hide from docs.
 

.envoy.api.v2.Cluster.RingHashLbConfig.DeprecatedV1 deprecated_v1 = 2 [deprecated = true];

Specified by:

getDeprecatedV1 in interface Cluster.RingHashLbConfigOrBuilder

getDeprecatedV1OrBuilder

@Deprecated
public Cluster.RingHashLbConfig.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()

Deprecated.

 Deprecated settings from v1 config.
 [#not-implemented-hide:] Hide from docs.
 

.envoy.api.v2.Cluster.RingHashLbConfig.DeprecatedV1 deprecated_v1 = 2 [deprecated = true];

Specified by:

getDeprecatedV1OrBuilder in interface Cluster.RingHashLbConfigOrBuilder

getHashFunctionValue

public int getHashFunctionValue()

 The hash function used to hash hosts onto the ketama ring. The value defaults to
 :ref:`XX_HASH<envoy_api_enum_value_Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
 

.envoy.api.v2.Cluster.RingHashLbConfig.HashFunction hash_function = 3 [(.validate.rules) = { ... }

Specified by:

getHashFunctionValue in interface Cluster.RingHashLbConfigOrBuilder

getHashFunction

public Cluster.RingHashLbConfig.HashFunction getHashFunction()

 The hash function used to hash hosts onto the ketama ring. The value defaults to
 :ref:`XX_HASH<envoy_api_enum_value_Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
 

.envoy.api.v2.Cluster.RingHashLbConfig.HashFunction hash_function = 3 [(.validate.rules) = { ... }

Specified by:

getHashFunction in interface Cluster.RingHashLbConfigOrBuilder

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 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

public static Cluster.RingHashLbConfig parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static Cluster.RingHashLbConfig parseFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cluster.RingHashLbConfig parseDelimitedFrom(InputStream input)
                                                   throws IOException

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

public Cluster.RingHashLbConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Cluster.RingHashLbConfig.Builder newBuilder()

newBuilder

public static Cluster.RingHashLbConfig.Builder newBuilder(Cluster.RingHashLbConfig prototype)

toBuilder

public Cluster.RingHashLbConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Cluster.RingHashLbConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cluster.RingHashLbConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Cluster.RingHashLbConfig> 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 Cluster.RingHashLbConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder