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

Class OutputConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.tap.v3.OutputConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OutputConfigOrBuilder, Serializable
public final class OutputConfig extends com.google.protobuf.GeneratedMessageV3 implements OutputConfigOrBuilder
 Tap output configuration.
 [#next-free-field: 6]
Protobuf type envoy.config.tap.v3.OutputConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    OutputConfig.Builder
    Tap output configuration.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MAX_BUFFERED_RX_BYTES_FIELD_NUMBER
     
    static final int
    MAX_BUFFERED_TX_BYTES_FIELD_NUMBER
     
    static final int
    MIN_STREAMED_SENT_BYTES_FIELD_NUMBER
     
    static final int
    SINKS_FIELD_NUMBER
     
    static final int
    STREAMING_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static OutputConfig
    getDefaultInstance()
     
    OutputConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.UInt32Value
    getMinStreamedSentBytes()
    Tapped messages will be sent on each read/write event for streamed tapping by default.
    com.google.protobuf.UInt32ValueOrBuilder
    getMinStreamedSentBytesOrBuilder()
    Tapped messages will be sent on each read/write event for streamed tapping by default.
    com.google.protobuf.Parser<OutputConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    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.
    boolean
    hasMinStreamedSentBytes()
    Tapped messages will be sent on each read/write event for streamed tapping by default.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static OutputConfig.Builder
    newBuilder()
     
    static OutputConfig.Builder
    newBuilder(OutputConfig prototype)
     
    OutputConfig.Builder
    newBuilderForType()
     
    protected OutputConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static OutputConfig
    parseDelimitedFrom(InputStream input)
     
    static OutputConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputConfig
    parseFrom(byte[] data)
     
    static OutputConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static OutputConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static OutputConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputConfig
    parseFrom(InputStream input)
     
    static OutputConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputConfig
    parseFrom(ByteBuffer data)
     
    static OutputConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<OutputConfig>
    parser()
     
    OutputConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • SINKS_FIELD_NUMBER

      public static final int SINKS_FIELD_NUMBER
      See Also:

    • MAX_BUFFERED_RX_BYTES_FIELD_NUMBER

      public static final int MAX_BUFFERED_RX_BYTES_FIELD_NUMBER
      See Also:

    • MAX_BUFFERED_TX_BYTES_FIELD_NUMBER

      public static final int MAX_BUFFERED_TX_BYTES_FIELD_NUMBER
      See Also:

    • STREAMING_FIELD_NUMBER

      public static final int STREAMING_FIELD_NUMBER
      See Also:

    • MIN_STREAMED_SENT_BYTES_FIELD_NUMBER

      public static final int MIN_STREAMED_SENT_BYTES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getSinksList

      public 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) = { ... }
      Specified by:
      getSinksList in interface OutputConfigOrBuilder

    • getSinksOrBuilderList

      public 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) = { ... }
      Specified by:
      getSinksOrBuilderList in interface OutputConfigOrBuilder

    • getSinksCount

      public 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) = { ... }
      Specified by:
      getSinksCount in interface OutputConfigOrBuilder

    • getSinks

      public 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) = { ... }
      Specified by:
      getSinks in interface OutputConfigOrBuilder

    • getSinksOrBuilder

      public 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) = { ... }
      Specified by:
      getSinksOrBuilder in interface OutputConfigOrBuilder

    • hasMaxBufferedRxBytes

      public 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;
      Specified by:
      hasMaxBufferedRxBytes in interface OutputConfigOrBuilder
      Returns:
      Whether the maxBufferedRxBytes field is set.

    • getMaxBufferedRxBytes

      public 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;
      Specified by:
      getMaxBufferedRxBytes in interface OutputConfigOrBuilder
      Returns:
      The maxBufferedRxBytes.

    • getMaxBufferedRxBytesOrBuilder

      public 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;
      Specified by:
      getMaxBufferedRxBytesOrBuilder in interface OutputConfigOrBuilder

    • hasMaxBufferedTxBytes

      public 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;
      Specified by:
      hasMaxBufferedTxBytes in interface OutputConfigOrBuilder
      Returns:
      Whether the maxBufferedTxBytes field is set.

    • getMaxBufferedTxBytes

      public 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;
      Specified by:
      getMaxBufferedTxBytes in interface OutputConfigOrBuilder
      Returns:
      The maxBufferedTxBytes.

    • getMaxBufferedTxBytesOrBuilder

      public 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;
      Specified by:
      getMaxBufferedTxBytesOrBuilder in interface OutputConfigOrBuilder

    • getStreaming

      public 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;
      Specified by:
      getStreaming in interface OutputConfigOrBuilder
      Returns:
      The streaming.

    • hasMinStreamedSentBytes

      public boolean hasMinStreamedSentBytes()
       Tapped messages will be sent on each read/write event for streamed tapping by default.
 But this behavior could be controlled by setting this field.
 If set then the tapped messages will be send once the threshold is reached.
 This could be used to avoid high frequent sending.
      .google.protobuf.UInt32Value min_streamed_sent_bytes = 5;
      Specified by:
      hasMinStreamedSentBytes in interface OutputConfigOrBuilder
      Returns:
      Whether the minStreamedSentBytes field is set.

    • getMinStreamedSentBytes

      public com.google.protobuf.UInt32Value getMinStreamedSentBytes()
       Tapped messages will be sent on each read/write event for streamed tapping by default.
 But this behavior could be controlled by setting this field.
 If set then the tapped messages will be send once the threshold is reached.
 This could be used to avoid high frequent sending.
      .google.protobuf.UInt32Value min_streamed_sent_bytes = 5;
      Specified by:
      getMinStreamedSentBytes in interface OutputConfigOrBuilder
      Returns:
      The minStreamedSentBytes.

    • getMinStreamedSentBytesOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMinStreamedSentBytesOrBuilder()
       Tapped messages will be sent on each read/write event for streamed tapping by default.
 But this behavior could be controlled by setting this field.
 If set then the tapped messages will be send once the threshold is reached.
 This could be used to avoid high frequent sending.
      .google.protobuf.UInt32Value min_streamed_sent_bytes = 5;
      Specified by:
      getMinStreamedSentBytesOrBuilder in interface OutputConfigOrBuilder

    • 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 OutputConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OutputConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OutputConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static OutputConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OutputConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OutputConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OutputConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OutputConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OutputConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static OutputConfig.Builder newBuilder()

    • newBuilder

      public static OutputConfig.Builder newBuilder(OutputConfig prototype)

    • toBuilder

      public OutputConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

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

    • getDefaultInstance

      public static OutputConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<OutputConfig> parser()

    • getParserForType

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