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

Class OutputSink

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OutputSinkOrBuilder, Serializable
    public final class OutputSink
extends com.google.protobuf.GeneratedMessageV3
implements OutputSinkOrBuilder
     Tap output sink configuration.
 [#next-free-field: 6]
    Protobuf type envoy.config.tap.v3.OutputSink
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OutputSink.Builder
      Tap output sink configuration.
      static class  OutputSink.Format
      Output format.
      static class  OutputSink.OutputSinkTypeCase  

      • 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

      • STREAMING_ADMIN_FIELD_NUMBER

        public static final int STREAMING_ADMIN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FILE_PER_TAP_FIELD_NUMBER

        public static final int FILE_PER_TAP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STREAMING_GRPC_FIELD_NUMBER

        public static final int STREAMING_GRPC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUFFERED_ADMIN_FIELD_NUMBER

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

      • getFormatValue

        public int getFormatValue()
         Sink output format.
        .envoy.config.tap.v3.OutputSink.Format format = 1 [(.validate.rules) = { ... }
        Specified by:
        getFormatValue in interface OutputSinkOrBuilder
        Returns:
        The enum numeric value on the wire for format.

      • getFormat

        public OutputSink.Format getFormat()
         Sink output format.
        .envoy.config.tap.v3.OutputSink.Format format = 1 [(.validate.rules) = { ... }
        Specified by:
        getFormat in interface OutputSinkOrBuilder
        Returns:
        The format.

      • hasStreamingAdmin

        public boolean hasStreamingAdmin()
         Tap output will be streamed out the :http:post:`/tap` admin endpoint.
 .. attention::
   It is only allowed to specify the streaming admin output sink if the tap is being
   configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
   been configured to receive tap configuration from some other source (e.g., static
   file, XDS, etc.) configuring the streaming admin output type will fail.
        .envoy.config.tap.v3.StreamingAdminSink streaming_admin = 2;
        Specified by:
        hasStreamingAdmin in interface OutputSinkOrBuilder
        Returns:
        Whether the streamingAdmin field is set.

      • getStreamingAdmin

        public StreamingAdminSink getStreamingAdmin()
         Tap output will be streamed out the :http:post:`/tap` admin endpoint.
 .. attention::
   It is only allowed to specify the streaming admin output sink if the tap is being
   configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
   been configured to receive tap configuration from some other source (e.g., static
   file, XDS, etc.) configuring the streaming admin output type will fail.
        .envoy.config.tap.v3.StreamingAdminSink streaming_admin = 2;
        Specified by:
        getStreamingAdmin in interface OutputSinkOrBuilder
        Returns:
        The streamingAdmin.

      • getStreamingAdminOrBuilder

        public StreamingAdminSinkOrBuilder getStreamingAdminOrBuilder()
         Tap output will be streamed out the :http:post:`/tap` admin endpoint.
 .. attention::
   It is only allowed to specify the streaming admin output sink if the tap is being
   configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
   been configured to receive tap configuration from some other source (e.g., static
   file, XDS, etc.) configuring the streaming admin output type will fail.
        .envoy.config.tap.v3.StreamingAdminSink streaming_admin = 2;
        Specified by:
        getStreamingAdminOrBuilder in interface OutputSinkOrBuilder

      • hasFilePerTap

        public boolean hasFilePerTap()
         Tap output will be written to a file per tap sink.
        .envoy.config.tap.v3.FilePerTapSink file_per_tap = 3;
        Specified by:
        hasFilePerTap in interface OutputSinkOrBuilder
        Returns:
        Whether the filePerTap field is set.

      • getFilePerTap

        public FilePerTapSink getFilePerTap()
         Tap output will be written to a file per tap sink.
        .envoy.config.tap.v3.FilePerTapSink file_per_tap = 3;
        Specified by:
        getFilePerTap in interface OutputSinkOrBuilder
        Returns:
        The filePerTap.

      • hasStreamingGrpc

        public boolean hasStreamingGrpc()
         [#not-implemented-hide:]
 GrpcService to stream data to. The format argument must be PROTO_BINARY.
 [#comment: TODO(samflattery): remove cleanup in uber_per_filter.cc once implemented]
        .envoy.config.tap.v3.StreamingGrpcSink streaming_grpc = 4;
        Specified by:
        hasStreamingGrpc in interface OutputSinkOrBuilder
        Returns:
        Whether the streamingGrpc field is set.

      • getStreamingGrpc

        public StreamingGrpcSink getStreamingGrpc()
         [#not-implemented-hide:]
 GrpcService to stream data to. The format argument must be PROTO_BINARY.
 [#comment: TODO(samflattery): remove cleanup in uber_per_filter.cc once implemented]
        .envoy.config.tap.v3.StreamingGrpcSink streaming_grpc = 4;
        Specified by:
        getStreamingGrpc in interface OutputSinkOrBuilder
        Returns:
        The streamingGrpc.

      • getStreamingGrpcOrBuilder

        public StreamingGrpcSinkOrBuilder getStreamingGrpcOrBuilder()
         [#not-implemented-hide:]
 GrpcService to stream data to. The format argument must be PROTO_BINARY.
 [#comment: TODO(samflattery): remove cleanup in uber_per_filter.cc once implemented]
        .envoy.config.tap.v3.StreamingGrpcSink streaming_grpc = 4;
        Specified by:
        getStreamingGrpcOrBuilder in interface OutputSinkOrBuilder

      • hasBufferedAdmin

        public boolean hasBufferedAdmin()
         Tap output will be buffered in a single block before flushing to the :http:post:`/tap` admin endpoint
 .. attention::
   It is only allowed to specify the buffered admin output sink if the tap is being
   configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
   been configured to receive tap configuration from some other source (e.g., static
   file, XDS, etc.) configuring the buffered admin output type will fail.
        .envoy.config.tap.v3.BufferedAdminSink buffered_admin = 5;
        Specified by:
        hasBufferedAdmin in interface OutputSinkOrBuilder
        Returns:
        Whether the bufferedAdmin field is set.

      • getBufferedAdmin

        public BufferedAdminSink getBufferedAdmin()
         Tap output will be buffered in a single block before flushing to the :http:post:`/tap` admin endpoint
 .. attention::
   It is only allowed to specify the buffered admin output sink if the tap is being
   configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
   been configured to receive tap configuration from some other source (e.g., static
   file, XDS, etc.) configuring the buffered admin output type will fail.
        .envoy.config.tap.v3.BufferedAdminSink buffered_admin = 5;
        Specified by:
        getBufferedAdmin in interface OutputSinkOrBuilder
        Returns:
        The bufferedAdmin.

      • getBufferedAdminOrBuilder

        public BufferedAdminSinkOrBuilder getBufferedAdminOrBuilder()
         Tap output will be buffered in a single block before flushing to the :http:post:`/tap` admin endpoint
 .. attention::
   It is only allowed to specify the buffered admin output sink if the tap is being
   configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
   been configured to receive tap configuration from some other source (e.g., static
   file, XDS, etc.) configuring the buffered admin output type will fail.
        .envoy.config.tap.v3.BufferedAdminSink buffered_admin = 5;
        Specified by:
        getBufferedAdminOrBuilder in interface OutputSinkOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static OutputSink getDefaultInstance()

      • parser

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

      • getParserForType

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