Interface HttpConnectionManager.HcmAccessLogOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HttpConnectionManager.HcmAccessLogOptions, HttpConnectionManager.HcmAccessLogOptions.Builder
Enclosing class:
HttpConnectionManager

public static interface HttpConnectionManager.HcmAccessLogOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    The interval to flush the above access logs.
    com.google.protobuf.DurationOrBuilder
    The interval to flush the above access logs.
    boolean
    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.
    boolean
    If true, the HCM will flush an access log when a tunnel is successfully established.
    boolean
    The interval to flush the above access logs.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasAccessLogFlushInterval

      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) = { ... }
      Returns:
      Whether the accessLogFlushInterval field is set.
    • getAccessLogFlushInterval

      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) = { ... }
      Returns:
      The accessLogFlushInterval.
    • getAccessLogFlushIntervalOrBuilder

      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) = { ... }
    • getFlushAccessLogOnNewRequest

      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;
      Returns:
      The flushAccessLogOnNewRequest.
    • getFlushLogOnTunnelSuccessfullyEstablished

      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;
      Returns:
      The flushLogOnTunnelSuccessfullyEstablished.