Package io.envoyproxy.envoy.config.core.v3

Class 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.GeneratedMessageV3
implements KeepaliveSettingsOrBuilder
    Protobuf type envoy.config.core.v3.KeepaliveSettings
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  KeepaliveSettings.Builder
      Protobuf type envoy.config.core.v3.KeepaliveSettings

      • 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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • INTERVAL_JITTER_FIELD_NUMBER

        public static final int INTERVAL_JITTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONNECTION_IDLE_INTERVAL_FIELD_NUMBER

        public static final int CONNECTION_IDLE_INTERVAL_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

      • 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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder

      • 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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder

      • 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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder

      • 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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder
        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 interface KeepaliveSettingsOrBuilder

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

        public static KeepaliveSettings parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public KeepaliveSettings.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public KeepaliveSettings.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected KeepaliveSettings.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<KeepaliveSettings> 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 KeepaliveSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder