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

Class OutputSink.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OutputSinkOrBuilder, Cloneable
    Enclosing class:
    OutputSink
    public static final class OutputSink.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>
implements OutputSinkOrBuilder
     Tap output sink configuration.
 [#next-free-field: 6]
    Protobuf type envoy.config.tap.v3.OutputSink

    • Method Detail

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

      • clear

        public OutputSink.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • getDefaultInstanceForType

        public OutputSink getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public OutputSink.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • setField

        public OutputSink.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • clearField

        public OutputSink.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • clearOneof

        public OutputSink.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • setRepeatedField

        public OutputSink.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • addRepeatedField

        public OutputSink.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • mergeFrom

        public OutputSink.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OutputSink.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • mergeFrom

        public OutputSink.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OutputSink.Builder>
        Throws:
        IOException

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

      • setFormatValue

        public OutputSink.Builder setFormatValue​(int value)
         Sink output format.
        .envoy.config.tap.v3.OutputSink.Format format = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The enum numeric value on the wire for format to set.
        Returns:
        This builder for chaining.

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

      • setFormat

        public OutputSink.Builder setFormat​(OutputSink.Format value)
         Sink output format.
        .envoy.config.tap.v3.OutputSink.Format format = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The format to set.
        Returns:
        This builder for chaining.

      • clearFormat

        public OutputSink.Builder clearFormat()
         Sink output format.
        .envoy.config.tap.v3.OutputSink.Format format = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

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

      • setStreamingAdmin

        public OutputSink.Builder setStreamingAdmin​(StreamingAdminSink value)
         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;

      • setStreamingAdmin

        public OutputSink.Builder setStreamingAdmin​(StreamingAdminSink.Builder builderForValue)
         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;

      • mergeStreamingAdmin

        public OutputSink.Builder mergeStreamingAdmin​(StreamingAdminSink value)
         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;

      • clearStreamingAdmin

        public OutputSink.Builder clearStreamingAdmin()
         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;

      • getStreamingAdminBuilder

        public StreamingAdminSink.Builder getStreamingAdminBuilder()
         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;

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

      • setFilePerTap

        public OutputSink.Builder setFilePerTap​(FilePerTapSink value)
         Tap output will be written to a file per tap sink.
        .envoy.config.tap.v3.FilePerTapSink file_per_tap = 3;

      • setFilePerTap

        public OutputSink.Builder setFilePerTap​(FilePerTapSink.Builder builderForValue)
         Tap output will be written to a file per tap sink.
        .envoy.config.tap.v3.FilePerTapSink file_per_tap = 3;

      • mergeFilePerTap

        public OutputSink.Builder mergeFilePerTap​(FilePerTapSink value)
         Tap output will be written to a file per tap sink.
        .envoy.config.tap.v3.FilePerTapSink file_per_tap = 3;

      • clearFilePerTap

        public OutputSink.Builder clearFilePerTap()
         Tap output will be written to a file per tap sink.
        .envoy.config.tap.v3.FilePerTapSink file_per_tap = 3;

      • getFilePerTapBuilder

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

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

      • setStreamingGrpc

        public OutputSink.Builder setStreamingGrpc​(StreamingGrpcSink value)
         [#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;

      • setStreamingGrpc

        public OutputSink.Builder setStreamingGrpc​(StreamingGrpcSink.Builder builderForValue)
         [#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;

      • mergeStreamingGrpc

        public OutputSink.Builder mergeStreamingGrpc​(StreamingGrpcSink value)
         [#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;

      • clearStreamingGrpc

        public OutputSink.Builder clearStreamingGrpc()
         [#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;

      • getStreamingGrpcBuilder

        public StreamingGrpcSink.Builder getStreamingGrpcBuilder()
         [#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;

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

      • setBufferedAdmin

        public OutputSink.Builder setBufferedAdmin​(BufferedAdminSink value)
         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;

      • setBufferedAdmin

        public OutputSink.Builder setBufferedAdmin​(BufferedAdminSink.Builder builderForValue)
         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;

      • mergeBufferedAdmin

        public OutputSink.Builder mergeBufferedAdmin​(BufferedAdminSink value)
         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;

      • clearBufferedAdmin

        public OutputSink.Builder clearBufferedAdmin()
         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;

      • getBufferedAdminBuilder

        public BufferedAdminSink.Builder getBufferedAdminBuilder()
         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;

      • 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

      • setUnknownFields

        public final OutputSink.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>

      • mergeUnknownFields

        public final OutputSink.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OutputSink.Builder>