Class KeepaliveSettings
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.core.v3.KeepaliveSettings
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,KeepaliveSettingsOrBuilder
,java.io.Serializable
public final class KeepaliveSettings extends com.google.protobuf.GeneratedMessage implements KeepaliveSettingsOrBuilder
Protobuf typeenvoy.config.core.v3.KeepaliveSettings
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
KeepaliveSettings.Builder
Protobuf typeenvoy.config.core.v3.KeepaliveSettings
-
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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
static int
CONNECTION_IDLE_INTERVAL_FIELD_NUMBER
private com.google.protobuf.Duration
connectionIdleInterval_
private static KeepaliveSettings
DEFAULT_INSTANCE
private com.google.protobuf.Duration
interval_
static int
INTERVAL_FIELD_NUMBER
static int
INTERVAL_JITTER_FIELD_NUMBER
private Percent
intervalJitter_
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<KeepaliveSettings>
PARSER
private static long
serialVersionUID
private com.google.protobuf.Duration
timeout_
static int
TIMEOUT_FIELD_NUMBER
-
Constructor Summary
Constructors Modifier Constructor Description private
KeepaliveSettings()
private
KeepaliveSettings(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
com.google.protobuf.Duration
getConnectionIdleInterval()
If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections.com.google.protobuf.DurationOrBuilder
getConnectionIdleIntervalOrBuilder()
If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections.static KeepaliveSettings
getDefaultInstance()
KeepaliveSettings
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Duration
getInterval()
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.Percent
getIntervalJitter()
A random jitter amount as a percentage of interval that will be added to each interval.PercentOrBuilder
getIntervalJitterOrBuilder()
A random jitter amount as a percentage of interval that will be added to each interval.com.google.protobuf.DurationOrBuilder
getIntervalOrBuilder()
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.com.google.protobuf.Parser<KeepaliveSettings>
getParserForType()
int
getSerializedSize()
com.google.protobuf.Duration
getTimeout()
How long to wait for a response to a keepalive PING.com.google.protobuf.DurationOrBuilder
getTimeoutOrBuilder()
How long to wait for a response to a keepalive PING.boolean
hasConnectionIdleInterval()
If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections.int
hashCode()
boolean
hasInterval()
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.boolean
hasIntervalJitter()
A random jitter amount as a percentage of interval that will be added to each interval.boolean
hasTimeout()
How long to wait for a response to a keepalive PING.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static KeepaliveSettings.Builder
newBuilder()
static KeepaliveSettings.Builder
newBuilder(KeepaliveSettings prototype)
KeepaliveSettings.Builder
newBuilderForType()
protected KeepaliveSettings.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static KeepaliveSettings
parseDelimitedFrom(java.io.InputStream input)
static KeepaliveSettings
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static KeepaliveSettings
parseFrom(byte[] data)
static KeepaliveSettings
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static KeepaliveSettings
parseFrom(com.google.protobuf.ByteString data)
static KeepaliveSettings
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static KeepaliveSettings
parseFrom(com.google.protobuf.CodedInputStream input)
static KeepaliveSettings
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static KeepaliveSettings
parseFrom(java.io.InputStream input)
static KeepaliveSettings
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static KeepaliveSettings
parseFrom(java.nio.ByteBuffer data)
static KeepaliveSettings
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<KeepaliveSettings>
parser()
KeepaliveSettings.Builder
toBuilder()
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
INTERVAL_FIELD_NUMBER
public static final int INTERVAL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
interval_
private com.google.protobuf.Duration interval_
-
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
timeout_
private com.google.protobuf.Duration timeout_
-
INTERVAL_JITTER_FIELD_NUMBER
public static final int INTERVAL_JITTER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
intervalJitter_
private Percent intervalJitter_
-
CONNECTION_IDLE_INTERVAL_FIELD_NUMBER
public static final int CONNECTION_IDLE_INTERVAL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
connectionIdleInterval_
private com.google.protobuf.Duration connectionIdleInterval_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final KeepaliveSettings DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<KeepaliveSettings> PARSER
-
-
Method Detail
-
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
-
hasInterval
public boolean hasInterval()
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive. If this is zero, interval PINGs will not be sent.
.google.protobuf.Duration interval = 1 [(.validate.rules) = { ... }
- Specified by:
hasInterval
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- Whether the interval field is set.
-
getInterval
public com.google.protobuf.Duration getInterval()
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive. If this is zero, interval PINGs will not be sent.
.google.protobuf.Duration interval = 1 [(.validate.rules) = { ... }
- Specified by:
getInterval
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- The interval.
-
getIntervalOrBuilder
public com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive. If this is zero, interval PINGs will not be sent.
.google.protobuf.Duration interval = 1 [(.validate.rules) = { ... }
- Specified by:
getIntervalOrBuilder
in interfaceKeepaliveSettingsOrBuilder
-
hasTimeout
public boolean hasTimeout()
How long to wait for a response to a keepalive PING. If a response is not received within this time period, the connection will be aborted. Note that in order to prevent the influence of Head-of-line (HOL) blocking the timeout period is extended when *any* frame is received on the connection, under the assumption that if a frame is received the connection is healthy.
.google.protobuf.Duration timeout = 2 [(.validate.rules) = { ... }
- Specified by:
hasTimeout
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- Whether the timeout field is set.
-
getTimeout
public com.google.protobuf.Duration getTimeout()
How long to wait for a response to a keepalive PING. If a response is not received within this time period, the connection will be aborted. Note that in order to prevent the influence of Head-of-line (HOL) blocking the timeout period is extended when *any* frame is received on the connection, under the assumption that if a frame is received the connection is healthy.
.google.protobuf.Duration timeout = 2 [(.validate.rules) = { ... }
- Specified by:
getTimeout
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- The timeout.
-
getTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
How long to wait for a response to a keepalive PING. If a response is not received within this time period, the connection will be aborted. Note that in order to prevent the influence of Head-of-line (HOL) blocking the timeout period is extended when *any* frame is received on the connection, under the assumption that if a frame is received the connection is healthy.
.google.protobuf.Duration timeout = 2 [(.validate.rules) = { ... }
- Specified by:
getTimeoutOrBuilder
in interfaceKeepaliveSettingsOrBuilder
-
hasIntervalJitter
public boolean hasIntervalJitter()
A random jitter amount as a percentage of interval that will be added to each interval. A value of zero means there will be no jitter. The default value is 15%.
.envoy.type.v3.Percent interval_jitter = 3;
- Specified by:
hasIntervalJitter
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- Whether the intervalJitter field is set.
-
getIntervalJitter
public Percent getIntervalJitter()
A random jitter amount as a percentage of interval that will be added to each interval. A value of zero means there will be no jitter. The default value is 15%.
.envoy.type.v3.Percent interval_jitter = 3;
- Specified by:
getIntervalJitter
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- The intervalJitter.
-
getIntervalJitterOrBuilder
public PercentOrBuilder getIntervalJitterOrBuilder()
A random jitter amount as a percentage of interval that will be added to each interval. A value of zero means there will be no jitter. The default value is 15%.
.envoy.type.v3.Percent interval_jitter = 3;
- Specified by:
getIntervalJitterOrBuilder
in interfaceKeepaliveSettingsOrBuilder
-
hasConnectionIdleInterval
public boolean hasConnectionIdleInterval()
If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections. If this is zero, this type of PING will not be sent. If an interval ping is outstanding, a second ping will not be sent as the interval ping will determine if the connection is dead. The same feature for HTTP/3 is given by inheritance from QUICHE which uses :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` and the current PTO of the connection to decide whether to probe before sending a new request.
.google.protobuf.Duration connection_idle_interval = 4 [(.validate.rules) = { ... }
- Specified by:
hasConnectionIdleInterval
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- Whether the connectionIdleInterval field is set.
-
getConnectionIdleInterval
public com.google.protobuf.Duration getConnectionIdleInterval()
If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections. If this is zero, this type of PING will not be sent. If an interval ping is outstanding, a second ping will not be sent as the interval ping will determine if the connection is dead. The same feature for HTTP/3 is given by inheritance from QUICHE which uses :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` and the current PTO of the connection to decide whether to probe before sending a new request.
.google.protobuf.Duration connection_idle_interval = 4 [(.validate.rules) = { ... }
- Specified by:
getConnectionIdleInterval
in interfaceKeepaliveSettingsOrBuilder
- Returns:
- The connectionIdleInterval.
-
getConnectionIdleIntervalOrBuilder
public com.google.protobuf.DurationOrBuilder getConnectionIdleIntervalOrBuilder()
If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections. If this is zero, this type of PING will not be sent. If an interval ping is outstanding, a second ping will not be sent as the interval ping will determine if the connection is dead. The same feature for HTTP/3 is given by inheritance from QUICHE which uses :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` and the current PTO of the connection to decide whether to probe before sending a new request.
.google.protobuf.Duration connection_idle_interval = 4 [(.validate.rules) = { ... }
- Specified by:
getConnectionIdleIntervalOrBuilder
in interfaceKeepaliveSettingsOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- 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 KeepaliveSettings parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static KeepaliveSettings parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static KeepaliveSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static KeepaliveSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static KeepaliveSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static KeepaliveSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static KeepaliveSettings parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static KeepaliveSettings parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static KeepaliveSettings parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static KeepaliveSettings parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static KeepaliveSettings parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static KeepaliveSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public KeepaliveSettings.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static KeepaliveSettings.Builder newBuilder()
-
newBuilder
public static KeepaliveSettings.Builder newBuilder(KeepaliveSettings prototype)
-
toBuilder
public KeepaliveSettings.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected KeepaliveSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static KeepaliveSettings getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<KeepaliveSettings> parser()
-
getParserForType
public com.google.protobuf.Parser<KeepaliveSettings> 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
public KeepaliveSettings getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-