Package io.envoyproxy.envoy.config.accesslog.v2

Interface CommonGrpcAccessLogConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CommonGrpcAccessLogConfig, CommonGrpcAccessLogConfig.Builder
    public interface CommonGrpcAccessLogConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Duration getBufferFlushInterval()
      Interval for flushing access logs to the gRPC stream.
      com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()
      Interval for flushing access logs to the gRPC stream.
      com.google.protobuf.UInt32Value getBufferSizeBytes()
      Soft size limit in bytes for access log entries buffer.
      com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder()
      Soft size limit in bytes for access log entries buffer.
      String getFilterStateObjectsToLog​(int index)
      Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
      com.google.protobuf.ByteString getFilterStateObjectsToLogBytes​(int index)
      Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
      int getFilterStateObjectsToLogCount()
      Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
      List<String> getFilterStateObjectsToLogList()
      Additional filter state objects to log in :ref:`filter_state_objects <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
      GrpcService getGrpcService()
      The gRPC service for the access log service.
      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
      The gRPC service for the access log service.
      String getLogName()
      The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier <envoy_api_msg_service.accesslog.v2.StreamAccessLogsMessage.Identifier>`.
      com.google.protobuf.ByteString getLogNameBytes()
      The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier <envoy_api_msg_service.accesslog.v2.StreamAccessLogsMessage.Identifier>`.
      boolean hasBufferFlushInterval()
      Interval for flushing access logs to the gRPC stream.
      boolean hasBufferSizeBytes()
      Soft size limit in bytes for access log entries buffer.
      boolean hasGrpcService()
      The gRPC service for the access log service.

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

      • getLogName

        String getLogName()
         The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier
 <envoy_api_msg_service.accesslog.v2.StreamAccessLogsMessage.Identifier>`. This allows the
 access log server to differentiate between different access logs coming from the same Envoy.
        string log_name = 1 [(.validate.rules) = { ... }
        Returns:
        The logName.

      • getLogNameBytes

        com.google.protobuf.ByteString getLogNameBytes()
         The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier
 <envoy_api_msg_service.accesslog.v2.StreamAccessLogsMessage.Identifier>`. This allows the
 access log server to differentiate between different access logs coming from the same Envoy.
        string log_name = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for logName.

      • hasGrpcService

        boolean hasGrpcService()
         The gRPC service for the access log service.
        .envoy.api.v2.core.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
        Returns:
        Whether the grpcService field is set.

      • getGrpcService

        GrpcService getGrpcService()
         The gRPC service for the access log service.
        .envoy.api.v2.core.GrpcService grpc_service = 2 [(.validate.rules) = { ... }
        Returns:
        The grpcService.

      • getGrpcServiceOrBuilder

        GrpcServiceOrBuilder getGrpcServiceOrBuilder()
         The gRPC service for the access log service.
        .envoy.api.v2.core.GrpcService grpc_service = 2 [(.validate.rules) = { ... }

      • hasBufferFlushInterval

        boolean hasBufferFlushInterval()
         Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
 this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
 1 second.
        .google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }
        Returns:
        Whether the bufferFlushInterval field is set.

      • getBufferFlushInterval

        com.google.protobuf.Duration getBufferFlushInterval()
         Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
 this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
 1 second.
        .google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }
        Returns:
        The bufferFlushInterval.

      • getBufferFlushIntervalOrBuilder

        com.google.protobuf.DurationOrBuilder getBufferFlushIntervalOrBuilder()
         Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
 this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
 1 second.
        .google.protobuf.Duration buffer_flush_interval = 3 [(.validate.rules) = { ... }

      • hasBufferSizeBytes

        boolean hasBufferSizeBytes()
         Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
 to zero effectively disables the batching. Defaults to 16384.
        .google.protobuf.UInt32Value buffer_size_bytes = 4;
        Returns:
        Whether the bufferSizeBytes field is set.

      • getBufferSizeBytes

        com.google.protobuf.UInt32Value getBufferSizeBytes()
         Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
 to zero effectively disables the batching. Defaults to 16384.
        .google.protobuf.UInt32Value buffer_size_bytes = 4;
        Returns:
        The bufferSizeBytes.

      • getBufferSizeBytesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getBufferSizeBytesOrBuilder()
         Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
 this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
 to zero effectively disables the batching. Defaults to 16384.
        .google.protobuf.UInt32Value buffer_size_bytes = 4;

      • getFilterStateObjectsToLogList

        List<String> getFilterStateObjectsToLogList()
         Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
        repeated string filter_state_objects_to_log = 5;
        Returns:
        A list containing the filterStateObjectsToLog.

      • getFilterStateObjectsToLogCount

        int getFilterStateObjectsToLogCount()
         Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
        repeated string filter_state_objects_to_log = 5;
        Returns:
        The count of filterStateObjectsToLog.

      • getFilterStateObjectsToLog

        String getFilterStateObjectsToLog​(int index)
         Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
        repeated string filter_state_objects_to_log = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The filterStateObjectsToLog at the given index.

      • getFilterStateObjectsToLogBytes

        com.google.protobuf.ByteString getFilterStateObjectsToLogBytes​(int index)
         Additional filter state objects to log in :ref:`filter_state_objects
 <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
 Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
        repeated string filter_state_objects_to_log = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the filterStateObjectsToLog at the given index.