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

Class 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.
    Protobuf type envoy.config.tap.v3.OutputConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static 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<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 Detail

      • MAX_BUFFERED_RX_BYTES_FIELD_NUMBER

        public static final int MAX_BUFFERED_RX_BYTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_BUFFERED_TX_BYTES_FIELD_NUMBER

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

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

      • 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​(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

      • 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