Package io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3

Class HttpConnectionManager.HcmAccessLogOptions.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<HttpConnectionManager.HcmAccessLogOptions.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<HttpConnectionManager.HcmAccessLogOptions.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • hasAccessLogFlushInterval

        public boolean hasAccessLogFlushInterval()
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }
        Specified by:
        hasAccessLogFlushInterval in interface HttpConnectionManager.HcmAccessLogOptionsOrBuilder
        Returns:
        Whether the accessLogFlushInterval field is set.

      • getAccessLogFlushInterval

        public com.google.protobuf.Duration getAccessLogFlushInterval()
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }
        Specified by:
        getAccessLogFlushInterval in interface HttpConnectionManager.HcmAccessLogOptionsOrBuilder
        Returns:
        The accessLogFlushInterval.

      • setAccessLogFlushInterval

        public HttpConnectionManager.HcmAccessLogOptions.Builder setAccessLogFlushInterval​(com.google.protobuf.Duration value)
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }

      • setAccessLogFlushInterval

        public HttpConnectionManager.HcmAccessLogOptions.Builder setAccessLogFlushInterval​(com.google.protobuf.Duration.Builder builderForValue)
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }

      • mergeAccessLogFlushInterval

        public HttpConnectionManager.HcmAccessLogOptions.Builder mergeAccessLogFlushInterval​(com.google.protobuf.Duration value)
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }

      • clearAccessLogFlushInterval

        public HttpConnectionManager.HcmAccessLogOptions.Builder clearAccessLogFlushInterval()
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }

      • getAccessLogFlushIntervalBuilder

        public com.google.protobuf.Duration.Builder getAccessLogFlushIntervalBuilder()
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }

      • getAccessLogFlushIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getAccessLogFlushIntervalOrBuilder()
         The interval to flush the above access logs. By default, the HCM will flush exactly one access log
 on stream close, when the HTTP request is complete. If this field is set, the HCM will flush access
 logs periodically at the specified interval. This is especially useful in the case of long-lived
 requests, such as CONNECT and Websockets. Final access logs can be detected via the
 ``requestComplete()`` method of ``StreamInfo`` in access log filters, or through the ``%DURATION%`` substitution
 string.
 The interval must be at least 1 millisecond.
        .google.protobuf.Duration access_log_flush_interval = 1 [(.validate.rules) = { ... }
        Specified by:
        getAccessLogFlushIntervalOrBuilder in interface HttpConnectionManager.HcmAccessLogOptionsOrBuilder

      • getFlushAccessLogOnNewRequest

        public boolean getFlushAccessLogOnNewRequest()
         If set to true, HCM will flush an access log when a new HTTP request is received, after request
 headers have been evaluated, before iterating through the HTTP filter chain.
 This log record, if enabled, does not depend on periodic log records or request completion log.
 Details related to upstream cluster, such as upstream host, will not be available for this log.
        bool flush_access_log_on_new_request = 2;
        Specified by:
        getFlushAccessLogOnNewRequest in interface HttpConnectionManager.HcmAccessLogOptionsOrBuilder
        Returns:
        The flushAccessLogOnNewRequest.

      • setFlushAccessLogOnNewRequest

        public HttpConnectionManager.HcmAccessLogOptions.Builder setFlushAccessLogOnNewRequest​(boolean value)
         If set to true, HCM will flush an access log when a new HTTP request is received, after request
 headers have been evaluated, before iterating through the HTTP filter chain.
 This log record, if enabled, does not depend on periodic log records or request completion log.
 Details related to upstream cluster, such as upstream host, will not be available for this log.
        bool flush_access_log_on_new_request = 2;
        Parameters:
        value - The flushAccessLogOnNewRequest to set.
        Returns:
        This builder for chaining.

      • clearFlushAccessLogOnNewRequest

        public HttpConnectionManager.HcmAccessLogOptions.Builder clearFlushAccessLogOnNewRequest()
         If set to true, HCM will flush an access log when a new HTTP request is received, after request
 headers have been evaluated, before iterating through the HTTP filter chain.
 This log record, if enabled, does not depend on periodic log records or request completion log.
 Details related to upstream cluster, such as upstream host, will not be available for this log.
        bool flush_access_log_on_new_request = 2;
        Returns:
        This builder for chaining.

      • getFlushLogOnTunnelSuccessfullyEstablished

        public boolean getFlushLogOnTunnelSuccessfullyEstablished()
         If true, the HCM will flush an access log when a tunnel is successfully established. For example,
 this could be when an upstream has successfully returned 101 Switching Protocols, or when the proxy
 has returned 200 to a CONNECT request.
        bool flush_log_on_tunnel_successfully_established = 3;
        Specified by:
        getFlushLogOnTunnelSuccessfullyEstablished in interface HttpConnectionManager.HcmAccessLogOptionsOrBuilder
        Returns:
        The flushLogOnTunnelSuccessfullyEstablished.

      • setFlushLogOnTunnelSuccessfullyEstablished

        public HttpConnectionManager.HcmAccessLogOptions.Builder setFlushLogOnTunnelSuccessfullyEstablished​(boolean value)
         If true, the HCM will flush an access log when a tunnel is successfully established. For example,
 this could be when an upstream has successfully returned 101 Switching Protocols, or when the proxy
 has returned 200 to a CONNECT request.
        bool flush_log_on_tunnel_successfully_established = 3;
        Parameters:
        value - The flushLogOnTunnelSuccessfullyEstablished to set.
        Returns:
        This builder for chaining.

      • clearFlushLogOnTunnelSuccessfullyEstablished

        public HttpConnectionManager.HcmAccessLogOptions.Builder clearFlushLogOnTunnelSuccessfullyEstablished()
         If true, the HCM will flush an access log when a tunnel is successfully established. For example,
 this could be when an upstream has successfully returned 101 Switching Protocols, or when the proxy
 has returned 200 to a CONNECT request.
        bool flush_log_on_tunnel_successfully_established = 3;
        Returns:
        This builder for chaining.