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

Interface OutputSinkOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OutputSink, OutputSink.Builder
public interface OutputSinkOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    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()
     
    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.
    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.

    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 Details

    • getFormatValue

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

    • getFormat

      OutputSink.Format getFormat()
       Sink output format.
      .envoy.config.tap.v3.OutputSink.Format format = 1 [(.validate.rules) = { ... }
      Returns:
      The format.

    • hasStreamingAdmin

      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;
      Returns:
      Whether the streamingAdmin field is set.

    • getStreamingAdmin

      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;
      Returns:
      The streamingAdmin.

    • getStreamingAdminOrBuilder

      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;

    • hasFilePerTap

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

    • getFilePerTap

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

    • getFilePerTapOrBuilder

      FilePerTapSinkOrBuilder getFilePerTapOrBuilder()
       Tap output will be written to a file per tap sink.
      .envoy.config.tap.v3.FilePerTapSink file_per_tap = 3;

    • hasStreamingGrpc

      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;
      Returns:
      Whether the streamingGrpc field is set.

    • getStreamingGrpc

      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;
      Returns:
      The streamingGrpc.

    • getStreamingGrpcOrBuilder

      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;

    • hasBufferedAdmin

      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;
      Returns:
      Whether the bufferedAdmin field is set.

    • getBufferedAdmin

      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;
      Returns:
      The bufferedAdmin.

    • getBufferedAdminOrBuilder

      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;

    • hasCustomSink

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

    • getCustomSink

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

    • getCustomSinkOrBuilder

      TypedExtensionConfigOrBuilder getCustomSinkOrBuilder()
       Tap output filter will be defined by an extension type
      .envoy.config.core.v3.TypedExtensionConfig custom_sink = 6;

    • getOutputSinkTypeCase

      OutputSink.OutputSinkTypeCase getOutputSinkTypeCase()