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

Class HttpConnectionManager.HcmAccessLogOptions

    • Field Detail

      • ACCESS_LOG_FLUSH_INTERVAL_FIELD_NUMBER

        public static final int ACCESS_LOG_FLUSH_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FLUSH_ACCESS_LOG_ON_NEW_REQUEST_FIELD_NUMBER

        public static final int FLUSH_ACCESS_LOG_ON_NEW_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FLUSH_LOG_ON_TUNNEL_SUCCESSFULLY_ESTABLISHED_FIELD_NUMBER

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

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

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

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

      • 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 HttpConnectionManager.HcmAccessLogOptions parseFrom​(ByteBuffer data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.HcmAccessLogOptions parseFrom​(com.google.protobuf.ByteString data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.HcmAccessLogOptions parseFrom​(com.google.protobuf.ByteString data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.HcmAccessLogOptions parseFrom​(byte[] data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.HcmAccessLogOptions parseFrom​(byte[] data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

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