Package io.envoyproxy.envoy.config.tap.v3

Interface OutputConfigOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.UInt32Value getMaxBufferedRxBytes()
      For buffered tapping, the maximum amount of received body that will be buffered prior to truncation.
      com.google.protobuf.UInt32ValueOrBuilder getMaxBufferedRxBytesOrBuilder()
      For buffered tapping, the maximum amount of received body that will be buffered prior to truncation.
      com.google.protobuf.UInt32Value getMaxBufferedTxBytes()
      For buffered tapping, the maximum amount of transmitted body that will be buffered prior to truncation.
      com.google.protobuf.UInt32ValueOrBuilder getMaxBufferedTxBytesOrBuilder()
      For buffered tapping, the maximum amount of transmitted body that will be buffered prior to truncation.
      OutputSink getSinks​(int index)
      Output sinks for tap data.
      int getSinksCount()
      Output sinks for tap data.
      List<OutputSink> getSinksList()
      Output sinks for tap data.
      OutputSinkOrBuilder getSinksOrBuilder​(int index)
      Output sinks for tap data.
      List<? extends OutputSinkOrBuilder> getSinksOrBuilderList()
      Output sinks for tap data.
      boolean getStreaming()
      Indicates whether taps produce a single buffered message per tap, or multiple streamed messages per tap in the emitted :ref:`TraceWrapper <envoy_v3_api_msg_data.tap.v3.TraceWrapper>` messages.
      boolean hasMaxBufferedRxBytes()
      For buffered tapping, the maximum amount of received body that will be buffered prior to truncation.
      boolean hasMaxBufferedTxBytes()
      For buffered tapping, the maximum amount of transmitted body that will be buffered prior to truncation.

      • 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

      • getSinksList

        List<OutputSink> getSinksList()
         Output sinks for tap data. Currently a single sink is allowed in the list. Once multiple
 sink types are supported this constraint will be relaxed.
        repeated .envoy.config.tap.v3.OutputSink sinks = 1 [(.validate.rules) = { ... }

      • getSinks

        OutputSink getSinks​(int index)
         Output sinks for tap data. Currently a single sink is allowed in the list. Once multiple
 sink types are supported this constraint will be relaxed.
        repeated .envoy.config.tap.v3.OutputSink sinks = 1 [(.validate.rules) = { ... }

      • getSinksCount

        int getSinksCount()
         Output sinks for tap data. Currently a single sink is allowed in the list. Once multiple
 sink types are supported this constraint will be relaxed.
        repeated .envoy.config.tap.v3.OutputSink sinks = 1 [(.validate.rules) = { ... }

      • getSinksOrBuilderList

        List<? extends OutputSinkOrBuilder> getSinksOrBuilderList()
         Output sinks for tap data. Currently a single sink is allowed in the list. Once multiple
 sink types are supported this constraint will be relaxed.
        repeated .envoy.config.tap.v3.OutputSink sinks = 1 [(.validate.rules) = { ... }

      • getSinksOrBuilder

        OutputSinkOrBuilder getSinksOrBuilder​(int index)
         Output sinks for tap data. Currently a single sink is allowed in the list. Once multiple
 sink types are supported this constraint will be relaxed.
        repeated .envoy.config.tap.v3.OutputSink sinks = 1 [(.validate.rules) = { ... }

      • hasMaxBufferedRxBytes

        boolean hasMaxBufferedRxBytes()
         For buffered tapping, the maximum amount of received body that will be buffered prior to
 truncation. If truncation occurs, the :ref:`truncated
 <envoy_v3_api_field_data.tap.v3.Body.truncated>` field will be set. If not specified, the
 default is 1KiB.
        .google.protobuf.UInt32Value max_buffered_rx_bytes = 2;
        Returns:
        Whether the maxBufferedRxBytes field is set.

      • getMaxBufferedRxBytes

        com.google.protobuf.UInt32Value getMaxBufferedRxBytes()
         For buffered tapping, the maximum amount of received body that will be buffered prior to
 truncation. If truncation occurs, the :ref:`truncated
 <envoy_v3_api_field_data.tap.v3.Body.truncated>` field will be set. If not specified, the
 default is 1KiB.
        .google.protobuf.UInt32Value max_buffered_rx_bytes = 2;
        Returns:
        The maxBufferedRxBytes.

      • getMaxBufferedRxBytesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxBufferedRxBytesOrBuilder()
         For buffered tapping, the maximum amount of received body that will be buffered prior to
 truncation. If truncation occurs, the :ref:`truncated
 <envoy_v3_api_field_data.tap.v3.Body.truncated>` field will be set. If not specified, the
 default is 1KiB.
        .google.protobuf.UInt32Value max_buffered_rx_bytes = 2;

      • hasMaxBufferedTxBytes

        boolean hasMaxBufferedTxBytes()
         For buffered tapping, the maximum amount of transmitted body that will be buffered prior to
 truncation. If truncation occurs, the :ref:`truncated
 <envoy_v3_api_field_data.tap.v3.Body.truncated>` field will be set. If not specified, the
 default is 1KiB.
        .google.protobuf.UInt32Value max_buffered_tx_bytes = 3;
        Returns:
        Whether the maxBufferedTxBytes field is set.

      • getMaxBufferedTxBytes

        com.google.protobuf.UInt32Value getMaxBufferedTxBytes()
         For buffered tapping, the maximum amount of transmitted body that will be buffered prior to
 truncation. If truncation occurs, the :ref:`truncated
 <envoy_v3_api_field_data.tap.v3.Body.truncated>` field will be set. If not specified, the
 default is 1KiB.
        .google.protobuf.UInt32Value max_buffered_tx_bytes = 3;
        Returns:
        The maxBufferedTxBytes.

      • getMaxBufferedTxBytesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxBufferedTxBytesOrBuilder()
         For buffered tapping, the maximum amount of transmitted body that will be buffered prior to
 truncation. If truncation occurs, the :ref:`truncated
 <envoy_v3_api_field_data.tap.v3.Body.truncated>` field will be set. If not specified, the
 default is 1KiB.
        .google.protobuf.UInt32Value max_buffered_tx_bytes = 3;

      • getStreaming

        boolean getStreaming()
         Indicates whether taps produce a single buffered message per tap, or multiple streamed
 messages per tap in the emitted :ref:`TraceWrapper
 <envoy_v3_api_msg_data.tap.v3.TraceWrapper>` messages. Note that streamed tapping does not
 mean that no buffering takes place. Buffering may be required if data is processed before a
 match can be determined. See the HTTP tap filter :ref:`streaming
 <config_http_filters_tap_streaming>` documentation for more information.
        bool streaming = 4;
        Returns:
        The streaming.