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

Class OutputSink

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.tap.v3.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: 7]
Protobuf type envoy.config.tap.v3.OutputSink
See Also:

  • Nested Class Summary

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

    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
    BUFFERED_ADMIN_FIELD_NUMBER
     
    static final int
    CUSTOM_SINK_FIELD_NUMBER
     
    static final int
    FILE_PER_TAP_FIELD_NUMBER
     
    static final int
    FORMAT_FIELD_NUMBER
     
    static final int
    STREAMING_ADMIN_FIELD_NUMBER
     
    static final int
    STREAMING_GRPC_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)
     
    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.
    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.
    TypedExtensionConfig
    getCustomSink()
    Tap output filter will be defined by an extension type
    TypedExtensionConfigOrBuilder
    getCustomSinkOrBuilder()
    Tap output filter will be defined by an extension type
    static OutputSink
    getDefaultInstance()
     
    OutputSink
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    FilePerTapSink
    getFilePerTap()
    Tap output will be written to a file per tap sink.
    FilePerTapSinkOrBuilder
    getFilePerTapOrBuilder()
    Tap output will be written to a file per tap sink.
    OutputSink.Format
    getFormat()
    Sink output format.
    int
    getFormatValue()
    Sink output format.
    OutputSink.OutputSinkTypeCase
    getOutputSinkTypeCase()
     
    com.google.protobuf.Parser<OutputSink>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    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.
    StreamingGrpcSink
    getStreamingGrpc()
    [#not-implemented-hide:] GrpcService to stream data to.
    StreamingGrpcSinkOrBuilder
    getStreamingGrpcOrBuilder()
    [#not-implemented-hide:] GrpcService to stream data to.
    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.
    boolean
    hasCustomSink()
    Tap output filter will be defined by an extension type
    boolean
    hasFilePerTap()
    Tap output will be written to a file per tap sink.
    int
    hashCode()
     
    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.
    boolean
    hasStreamingGrpc()
    [#not-implemented-hide:] GrpcService to stream data to.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static OutputSink.Builder
    newBuilder()
     
    static OutputSink.Builder
    newBuilder(OutputSink prototype)
     
    OutputSink.Builder
    newBuilderForType()
     
    protected OutputSink.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static OutputSink
    parseDelimitedFrom(InputStream input)
     
    static OutputSink
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputSink
    parseFrom(byte[] data)
     
    static OutputSink
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputSink
    parseFrom(com.google.protobuf.ByteString data)
     
    static OutputSink
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputSink
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static OutputSink
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputSink
    parseFrom(InputStream input)
     
    static OutputSink
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputSink
    parseFrom(ByteBuffer data)
     
    static OutputSink
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<OutputSink>
    parser()
     
    OutputSink.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

    • FORMAT_FIELD_NUMBER

      public static final int FORMAT_FIELD_NUMBER
      See Also:

    • STREAMING_ADMIN_FIELD_NUMBER

      public static final int STREAMING_ADMIN_FIELD_NUMBER
      See Also:

    • FILE_PER_TAP_FIELD_NUMBER

      public static final int FILE_PER_TAP_FIELD_NUMBER
      See Also:

    • STREAMING_GRPC_FIELD_NUMBER

      public static final int STREAMING_GRPC_FIELD_NUMBER
      See Also:

    • BUFFERED_ADMIN_FIELD_NUMBER

      public static final int BUFFERED_ADMIN_FIELD_NUMBER
      See Also:

    • CUSTOM_SINK_FIELD_NUMBER

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

    • getOutputSinkTypeCase

      public OutputSink.OutputSinkTypeCase getOutputSinkTypeCase()
      Specified by:
      getOutputSinkTypeCase in interface OutputSinkOrBuilder

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

    • getFilePerTapOrBuilder

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

    • 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

    • hasCustomSink

      public boolean hasCustomSink()
       Tap output filter will be defined by an extension type
      .envoy.config.core.v3.TypedExtensionConfig custom_sink = 6;
      Specified by:
      hasCustomSink in interface OutputSinkOrBuilder
      Returns:
      Whether the customSink field is set.

    • getCustomSink

      public TypedExtensionConfig getCustomSink()
       Tap output filter will be defined by an extension type
      .envoy.config.core.v3.TypedExtensionConfig custom_sink = 6;
      Specified by:
      getCustomSink in interface OutputSinkOrBuilder
      Returns:
      The customSink.

    • getCustomSinkOrBuilder

      public TypedExtensionConfigOrBuilder getCustomSinkOrBuilder()
       Tap output filter will be defined by an extension type
      .envoy.config.core.v3.TypedExtensionConfig custom_sink = 6;
      Specified by:
      getCustomSinkOrBuilder 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static OutputSink.Builder newBuilder()

    • newBuilder

      public static OutputSink.Builder newBuilder(OutputSink prototype)

    • 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