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

Class KeepaliveSettings.Builder

    • Method Detail

      • 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.Builder<KeepaliveSettings.Builder>

      • clear

        public KeepaliveSettings.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • getDefaultInstanceForType

        public KeepaliveSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public KeepaliveSettings.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • setField

        public KeepaliveSettings.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • clearField

        public KeepaliveSettings.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • clearOneof

        public KeepaliveSettings.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • setRepeatedField

        public KeepaliveSettings.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • addRepeatedField

        public KeepaliveSettings.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • mergeFrom

        public KeepaliveSettings.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeepaliveSettings.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • mergeFrom

        public KeepaliveSettings.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeepaliveSettings.Builder>
        Throws:
        IOException

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

      • setInterval

        public KeepaliveSettings.Builder setInterval​(com.google.protobuf.Duration value)
         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) = { ... }

      • setInterval

        public KeepaliveSettings.Builder setInterval​(com.google.protobuf.Duration.Builder builderForValue)
         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) = { ... }

      • mergeInterval

        public KeepaliveSettings.Builder mergeInterval​(com.google.protobuf.Duration value)
         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) = { ... }

      • clearInterval

        public KeepaliveSettings.Builder clearInterval()
         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) = { ... }

      • getIntervalBuilder

        public com.google.protobuf.Duration.Builder getIntervalBuilder()
         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) = { ... }

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

      • setTimeout

        public KeepaliveSettings.Builder setTimeout​(com.google.protobuf.Duration value)
         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) = { ... }

      • setTimeout

        public KeepaliveSettings.Builder setTimeout​(com.google.protobuf.Duration.Builder builderForValue)
         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) = { ... }

      • mergeTimeout

        public KeepaliveSettings.Builder mergeTimeout​(com.google.protobuf.Duration value)
         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) = { ... }

      • clearTimeout

        public KeepaliveSettings.Builder clearTimeout()
         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) = { ... }

      • getTimeoutBuilder

        public com.google.protobuf.Duration.Builder getTimeoutBuilder()
         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) = { ... }

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

      • setIntervalJitter

        public KeepaliveSettings.Builder setIntervalJitter​(Percent value)
         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;

      • setIntervalJitter

        public KeepaliveSettings.Builder setIntervalJitter​(Percent.Builder builderForValue)
         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;

      • mergeIntervalJitter

        public KeepaliveSettings.Builder mergeIntervalJitter​(Percent value)
         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;

      • clearIntervalJitter

        public KeepaliveSettings.Builder clearIntervalJitter()
         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;

      • getIntervalJitterBuilder

        public Percent.Builder getIntervalJitterBuilder()
         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;

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

      • setConnectionIdleInterval

        public KeepaliveSettings.Builder setConnectionIdleInterval​(com.google.protobuf.Duration value)
         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) = { ... }

      • setConnectionIdleInterval

        public KeepaliveSettings.Builder setConnectionIdleInterval​(com.google.protobuf.Duration.Builder builderForValue)
         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) = { ... }

      • mergeConnectionIdleInterval

        public KeepaliveSettings.Builder mergeConnectionIdleInterval​(com.google.protobuf.Duration value)
         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) = { ... }

      • clearConnectionIdleInterval

        public KeepaliveSettings.Builder clearConnectionIdleInterval()
         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) = { ... }

      • getConnectionIdleIntervalBuilder

        public com.google.protobuf.Duration.Builder getConnectionIdleIntervalBuilder()
         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) = { ... }

      • 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

      • setUnknownFields

        public final KeepaliveSettings.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>

      • mergeUnknownFields

        public final KeepaliveSettings.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeepaliveSettings.Builder>