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
,Serializable
public final class KeepaliveSettings
extends com.google.protobuf.GeneratedMessage
implements KeepaliveSettingsOrBuilder
Protobuf type
envoy.config.core.v3.KeepaliveSettings
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
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>, 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
static final int
private com.google.protobuf.Duration
private static final KeepaliveSettings
private com.google.protobuf.Duration
static final int
static final int
private Percent
private byte
private static final com.google.protobuf.Parser
<KeepaliveSettings> private static final long
private com.google.protobuf.Duration
static final int
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
KeepaliveSettings
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
com.google.protobuf.Duration
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
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
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Duration
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.A random jitter amount as a percentage of interval that will be added to each interval.A random jitter amount as a percentage of interval that will be added to each interval.com.google.protobuf.DurationOrBuilder
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.com.google.protobuf.Parser
<KeepaliveSettings> int
com.google.protobuf.Duration
How long to wait for a response to a keepalive PING.com.google.protobuf.DurationOrBuilder
How long to wait for a response to a keepalive PING.boolean
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
Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.boolean
A random jitter amount as a percentage of interval that will be added to each interval.boolean
How long to wait for a response to a keepalive PING.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static KeepaliveSettings.Builder
static KeepaliveSettings.Builder
newBuilder
(KeepaliveSettings prototype) protected KeepaliveSettings.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static KeepaliveSettings
parseDelimitedFrom
(InputStream input) static KeepaliveSettings
parseDelimitedFrom
(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
(InputStream input) static KeepaliveSettings
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeepaliveSettings
parseFrom
(ByteBuffer data) static KeepaliveSettings
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<KeepaliveSettings> 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_ -
INTERVAL_FIELD_NUMBER
public static final int INTERVAL_FIELD_NUMBER- See Also:
-
interval_
private com.google.protobuf.Duration interval_ -
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER- See Also:
-
timeout_
private com.google.protobuf.Duration timeout_ -
INTERVAL_JITTER_FIELD_NUMBER
public static final int INTERVAL_JITTER_FIELD_NUMBER- See Also:
-
intervalJitter_
-
CONNECTION_IDLE_INTERVAL_FIELD_NUMBER
public static final int CONNECTION_IDLE_INTERVAL_FIELD_NUMBER- See Also:
-
connectionIdleInterval_
private com.google.protobuf.Duration connectionIdleInterval_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
KeepaliveSettings
private KeepaliveSettings(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
KeepaliveSettings
private KeepaliveSettings()
-
-
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
-
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
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
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
- 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 KeepaliveSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static KeepaliveSettings parseFrom(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
- Throws:
IOException
-
parseFrom
public static KeepaliveSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static KeepaliveSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static KeepaliveSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static KeepaliveSettings 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 KeepaliveSettings.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
-