io.envoyproxy.envoy.config.cluster.v4alpha

Class Cluster.PreconnectPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.cluster.v4alpha.Cluster.PreconnectPolicy

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.PreconnectPolicyOrBuilder, Serializable

Enclosing class:

Cluster

public static final class Cluster.PreconnectPolicy
extends com.google.protobuf.GeneratedMessageV3
implements Cluster.PreconnectPolicyOrBuilder

 [#not-implemented-hide:]
 

Protobuf type envoy.config.cluster.v4alpha.Cluster.PreconnectPolicy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.PreconnectPolicy.Builder [#not-implemented-hide:] Protobuf type envoy.config.cluster.v4alpha.Cluster.PreconnectPolicy

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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	PER_UPSTREAM_PRECONNECT_RATIO_FIELD_NUMBER
static int	PREDICTIVE_PRECONNECT_RATIO_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.PreconnectPolicy	getDefaultInstance()
Cluster.PreconnectPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Cluster.PreconnectPolicy>	getParserForType()
com.google.protobuf.DoubleValue	getPerUpstreamPreconnectRatio() Indicates how many streams (rounded up) can be anticipated per-upstream for each incoming stream.
com.google.protobuf.DoubleValueOrBuilder	getPerUpstreamPreconnectRatioOrBuilder() Indicates how many streams (rounded up) can be anticipated per-upstream for each incoming stream.
com.google.protobuf.DoubleValue	getPredictivePreconnectRatio() Indicates how many many streams (rounded up) can be anticipated across a cluster for each stream, useful for low QPS services.
com.google.protobuf.DoubleValueOrBuilder	getPredictivePreconnectRatioOrBuilder() Indicates how many many streams (rounded up) can be anticipated across a cluster for each stream, useful for low QPS services.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasPerUpstreamPreconnectRatio() Indicates how many streams (rounded up) can be anticipated per-upstream for each incoming stream.
boolean	hasPredictivePreconnectRatio() Indicates how many many streams (rounded up) can be anticipated across a cluster for each stream, useful for low QPS services.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Cluster.PreconnectPolicy.Builder	newBuilder()
static Cluster.PreconnectPolicy.Builder	newBuilder(Cluster.PreconnectPolicy prototype)
Cluster.PreconnectPolicy.Builder	newBuilderForType()
protected Cluster.PreconnectPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Cluster.PreconnectPolicy	parseDelimitedFrom(InputStream input)
static Cluster.PreconnectPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.PreconnectPolicy	parseFrom(byte[] data)
static Cluster.PreconnectPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.PreconnectPolicy	parseFrom(ByteBuffer data)
static Cluster.PreconnectPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.PreconnectPolicy	parseFrom(com.google.protobuf.ByteString data)
static Cluster.PreconnectPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.PreconnectPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static Cluster.PreconnectPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.PreconnectPolicy	parseFrom(InputStream input)
static Cluster.PreconnectPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cluster.PreconnectPolicy>	parser()
Cluster.PreconnectPolicy.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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.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

PER_UPSTREAM_PRECONNECT_RATIO_FIELD_NUMBER

public static final int PER_UPSTREAM_PRECONNECT_RATIO_FIELD_NUMBER

See Also:

Constant Field Values

PREDICTIVE_PRECONNECT_RATIO_FIELD_NUMBER

public static final int PREDICTIVE_PRECONNECT_RATIO_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

hasPerUpstreamPreconnectRatio

public boolean hasPerUpstreamPreconnectRatio()

 Indicates how many streams (rounded up) can be anticipated per-upstream for each
 incoming stream. This is useful for high-QPS or latency-sensitive services. Preconnecting
 will only be done if the upstream is healthy.
 For example if this is 2, for an incoming HTTP/1.1 stream, 2 connections will be
 established, one for the new incoming stream, and one for a presumed follow-up stream. For
 HTTP/2, only one connection would be established by default as one connection can
 serve both the original and presumed follow-up stream.
 In steady state for non-multiplexed connections a value of 1.5 would mean if there were 100
 active streams, there would be 100 connections in use, and 50 connections preconnected.
 This might be a useful value for something like short lived single-use connections,
 for example proxying HTTP/1.1 if keep-alive were false and each stream resulted in connection
 termination. It would likely be overkill for long lived connections, such as TCP proxying SMTP
 or regular HTTP/1.1 with keep-alive. For long lived traffic, a value of 1.05 would be more
 reasonable, where for every 100 connections, 5 preconnected connections would be in the queue
 in case of unexpected disconnects where the connection could not be reused.
 If this value is not set, or set explicitly to one, Envoy will fetch as many connections
 as needed to serve streams in flight. This means in steady state if a connection is torn down,
 a subsequent streams will pay an upstream-rtt latency penalty waiting for streams to be
 preconnected.
 This is limited somewhat arbitrarily to 3 because preconnecting too aggressively can
 harm latency more than the preconnecting helps.
 

.google.protobuf.DoubleValue per_upstream_preconnect_ratio = 1 [(.validate.rules) = { ... }

Specified by:

hasPerUpstreamPreconnectRatio in interface Cluster.PreconnectPolicyOrBuilder

getPerUpstreamPreconnectRatio

public com.google.protobuf.DoubleValue getPerUpstreamPreconnectRatio()

 Indicates how many streams (rounded up) can be anticipated per-upstream for each
 incoming stream. This is useful for high-QPS or latency-sensitive services. Preconnecting
 will only be done if the upstream is healthy.
 For example if this is 2, for an incoming HTTP/1.1 stream, 2 connections will be
 established, one for the new incoming stream, and one for a presumed follow-up stream. For
 HTTP/2, only one connection would be established by default as one connection can
 serve both the original and presumed follow-up stream.
 In steady state for non-multiplexed connections a value of 1.5 would mean if there were 100
 active streams, there would be 100 connections in use, and 50 connections preconnected.
 This might be a useful value for something like short lived single-use connections,
 for example proxying HTTP/1.1 if keep-alive were false and each stream resulted in connection
 termination. It would likely be overkill for long lived connections, such as TCP proxying SMTP
 or regular HTTP/1.1 with keep-alive. For long lived traffic, a value of 1.05 would be more
 reasonable, where for every 100 connections, 5 preconnected connections would be in the queue
 in case of unexpected disconnects where the connection could not be reused.
 If this value is not set, or set explicitly to one, Envoy will fetch as many connections
 as needed to serve streams in flight. This means in steady state if a connection is torn down,
 a subsequent streams will pay an upstream-rtt latency penalty waiting for streams to be
 preconnected.
 This is limited somewhat arbitrarily to 3 because preconnecting too aggressively can
 harm latency more than the preconnecting helps.
 

.google.protobuf.DoubleValue per_upstream_preconnect_ratio = 1 [(.validate.rules) = { ... }

Specified by:

getPerUpstreamPreconnectRatio in interface Cluster.PreconnectPolicyOrBuilder

getPerUpstreamPreconnectRatioOrBuilder

public com.google.protobuf.DoubleValueOrBuilder getPerUpstreamPreconnectRatioOrBuilder()

 Indicates how many streams (rounded up) can be anticipated per-upstream for each
 incoming stream. This is useful for high-QPS or latency-sensitive services. Preconnecting
 will only be done if the upstream is healthy.
 For example if this is 2, for an incoming HTTP/1.1 stream, 2 connections will be
 established, one for the new incoming stream, and one for a presumed follow-up stream. For
 HTTP/2, only one connection would be established by default as one connection can
 serve both the original and presumed follow-up stream.
 In steady state for non-multiplexed connections a value of 1.5 would mean if there were 100
 active streams, there would be 100 connections in use, and 50 connections preconnected.
 This might be a useful value for something like short lived single-use connections,
 for example proxying HTTP/1.1 if keep-alive were false and each stream resulted in connection
 termination. It would likely be overkill for long lived connections, such as TCP proxying SMTP
 or regular HTTP/1.1 with keep-alive. For long lived traffic, a value of 1.05 would be more
 reasonable, where for every 100 connections, 5 preconnected connections would be in the queue
 in case of unexpected disconnects where the connection could not be reused.
 If this value is not set, or set explicitly to one, Envoy will fetch as many connections
 as needed to serve streams in flight. This means in steady state if a connection is torn down,
 a subsequent streams will pay an upstream-rtt latency penalty waiting for streams to be
 preconnected.
 This is limited somewhat arbitrarily to 3 because preconnecting too aggressively can
 harm latency more than the preconnecting helps.
 

.google.protobuf.DoubleValue per_upstream_preconnect_ratio = 1 [(.validate.rules) = { ... }

Specified by:

getPerUpstreamPreconnectRatioOrBuilder in interface Cluster.PreconnectPolicyOrBuilder

hasPredictivePreconnectRatio

public boolean hasPredictivePreconnectRatio()

 Indicates how many many streams (rounded up) can be anticipated across a cluster for each
 stream, useful for low QPS services. This is currently supported for a subset of
 deterministic non-hash-based load-balancing algorithms (weighted round robin, random).
 Unlike per_upstream_preconnect_ratio this preconnects across the upstream instances in a
 cluster, doing best effort predictions of what upstream would be picked next and
 pre-establishing a connection.
 For example if preconnecting is set to 2 for a round robin HTTP/2 cluster, on the first
 incoming stream, 2 connections will be preconnected - one to the first upstream for this
 cluster, one to the second on the assumption there will be a follow-up stream.
 Preconnecting will be limited to one preconnect per configured upstream in the cluster.
 If this value is not set, or set explicitly to one, Envoy will fetch as many connections
 as needed to serve streams in flight, so during warm up and in steady state if a connection
 is closed (and per_upstream_preconnect_ratio is not set), there will be a latency hit for
 connection establishment.
 If both this and preconnect_ratio are set, Envoy will make sure both predicted needs are met,
 basically preconnecting max(predictive-preconnect, per-upstream-preconnect), for each upstream.
 TODO(alyssawilk) per LB docs and LB overview docs when unhiding.
 

.google.protobuf.DoubleValue predictive_preconnect_ratio = 2 [(.validate.rules) = { ... }

Specified by:

hasPredictivePreconnectRatio in interface Cluster.PreconnectPolicyOrBuilder

getPredictivePreconnectRatio

public com.google.protobuf.DoubleValue getPredictivePreconnectRatio()

 Indicates how many many streams (rounded up) can be anticipated across a cluster for each
 stream, useful for low QPS services. This is currently supported for a subset of
 deterministic non-hash-based load-balancing algorithms (weighted round robin, random).
 Unlike per_upstream_preconnect_ratio this preconnects across the upstream instances in a
 cluster, doing best effort predictions of what upstream would be picked next and
 pre-establishing a connection.
 For example if preconnecting is set to 2 for a round robin HTTP/2 cluster, on the first
 incoming stream, 2 connections will be preconnected - one to the first upstream for this
 cluster, one to the second on the assumption there will be a follow-up stream.
 Preconnecting will be limited to one preconnect per configured upstream in the cluster.
 If this value is not set, or set explicitly to one, Envoy will fetch as many connections
 as needed to serve streams in flight, so during warm up and in steady state if a connection
 is closed (and per_upstream_preconnect_ratio is not set), there will be a latency hit for
 connection establishment.
 If both this and preconnect_ratio are set, Envoy will make sure both predicted needs are met,
 basically preconnecting max(predictive-preconnect, per-upstream-preconnect), for each upstream.
 TODO(alyssawilk) per LB docs and LB overview docs when unhiding.
 

.google.protobuf.DoubleValue predictive_preconnect_ratio = 2 [(.validate.rules) = { ... }

Specified by:

getPredictivePreconnectRatio in interface Cluster.PreconnectPolicyOrBuilder

getPredictivePreconnectRatioOrBuilder

public com.google.protobuf.DoubleValueOrBuilder getPredictivePreconnectRatioOrBuilder()

 Indicates how many many streams (rounded up) can be anticipated across a cluster for each
 stream, useful for low QPS services. This is currently supported for a subset of
 deterministic non-hash-based load-balancing algorithms (weighted round robin, random).
 Unlike per_upstream_preconnect_ratio this preconnects across the upstream instances in a
 cluster, doing best effort predictions of what upstream would be picked next and
 pre-establishing a connection.
 For example if preconnecting is set to 2 for a round robin HTTP/2 cluster, on the first
 incoming stream, 2 connections will be preconnected - one to the first upstream for this
 cluster, one to the second on the assumption there will be a follow-up stream.
 Preconnecting will be limited to one preconnect per configured upstream in the cluster.
 If this value is not set, or set explicitly to one, Envoy will fetch as many connections
 as needed to serve streams in flight, so during warm up and in steady state if a connection
 is closed (and per_upstream_preconnect_ratio is not set), there will be a latency hit for
 connection establishment.
 If both this and preconnect_ratio are set, Envoy will make sure both predicted needs are met,
 basically preconnecting max(predictive-preconnect, per-upstream-preconnect), for each upstream.
 TODO(alyssawilk) per LB docs and LB overview docs when unhiding.
 

.google.protobuf.DoubleValue predictive_preconnect_ratio = 2 [(.validate.rules) = { ... }

Specified by:

getPredictivePreconnectRatioOrBuilder in interface Cluster.PreconnectPolicyOrBuilder

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.PreconnectPolicy parseFrom(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.PreconnectPolicy parseFrom(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.PreconnectPolicy parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.PreconnectPolicy 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.PreconnectPolicy parseFrom(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.PreconnectPolicy parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Cluster.PreconnectPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Cluster.PreconnectPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Cluster.PreconnectPolicy.Builder newBuilder()

newBuilder

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

toBuilder

public Cluster.PreconnectPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cluster.PreconnectPolicy getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder