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

Class BufferedAdminSink.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<BufferedAdminSink.Builder>
io.envoyproxy.envoy.config.tap.v3.BufferedAdminSink.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BufferedAdminSinkOrBuilder, Cloneable
Enclosing class:
BufferedAdminSink
public static final class BufferedAdminSink.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<BufferedAdminSink.Builder> implements BufferedAdminSinkOrBuilder
 BufferedAdminSink configures a tap output to collect traces without returning them until
 one of multiple criteria are satisfied.
 Similar to StreamingAdminSink, it is only allowed to specify the buffered admin output
 sink if the tap is being configured from the ``/tap`` admin endpoint.
Protobuf type envoy.config.tap.v3.BufferedAdminSink

  • Method Details

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

    • clear

      public BufferedAdminSink.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<BufferedAdminSink.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<BufferedAdminSink.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public BufferedAdminSink.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<BufferedAdminSink.Builder>

    • setField

      public BufferedAdminSink.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<BufferedAdminSink.Builder>

    • clearField

      public BufferedAdminSink.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<BufferedAdminSink.Builder>

    • clearOneof

      public BufferedAdminSink.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<BufferedAdminSink.Builder>

    • setRepeatedField

      public BufferedAdminSink.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<BufferedAdminSink.Builder>

    • addRepeatedField

      public BufferedAdminSink.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<BufferedAdminSink.Builder>

    • mergeFrom

      public BufferedAdminSink.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<BufferedAdminSink.Builder>

    • mergeFrom

      public BufferedAdminSink.Builder mergeFrom(BufferedAdminSink other)

    • isInitialized

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

    • mergeFrom

      public BufferedAdminSink.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<BufferedAdminSink.Builder>
      Throws:
      IOException

    • getMaxTraces

      public long getMaxTraces()
       Stop collecting traces when the specified number are collected.
 If other criteria for ending collection are reached first, this value will not be used.
      uint64 max_traces = 1 [(.validate.rules) = { ... }
      Specified by:
      getMaxTraces in interface BufferedAdminSinkOrBuilder
      Returns:
      The maxTraces.

    • setMaxTraces

      public BufferedAdminSink.Builder setMaxTraces(long value)
       Stop collecting traces when the specified number are collected.
 If other criteria for ending collection are reached first, this value will not be used.
      uint64 max_traces = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The maxTraces to set.
      Returns:
      This builder for chaining.

    • clearMaxTraces

      public BufferedAdminSink.Builder clearMaxTraces()
       Stop collecting traces when the specified number are collected.
 If other criteria for ending collection are reached first, this value will not be used.
      uint64 max_traces = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • hasTimeout

      public boolean hasTimeout()
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;
      Specified by:
      hasTimeout in interface BufferedAdminSinkOrBuilder
      Returns:
      Whether the timeout field is set.

    • getTimeout

      public com.google.protobuf.Duration getTimeout()
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;
      Specified by:
      getTimeout in interface BufferedAdminSinkOrBuilder
      Returns:
      The timeout.

    • setTimeout

      public BufferedAdminSink.Builder setTimeout(com.google.protobuf.Duration value)
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;

    • setTimeout

      public BufferedAdminSink.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue)
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;

    • mergeTimeout

      public BufferedAdminSink.Builder mergeTimeout(com.google.protobuf.Duration value)
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;

    • clearTimeout

      public BufferedAdminSink.Builder clearTimeout()
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;

    • getTimeoutBuilder

      public com.google.protobuf.Duration.Builder getTimeoutBuilder()
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;

    • getTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       Acts as a fallback to prevent the client from waiting for long periods of time.
 After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
 This may result in returning fewer traces than were requested, and in the case that no traces are
 buffered during this time, no traces will be returned.
 Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
      .google.protobuf.Duration timeout = 2;
      Specified by:
      getTimeoutOrBuilder in interface BufferedAdminSinkOrBuilder

    • setUnknownFields

      public final BufferedAdminSink.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<BufferedAdminSink.Builder>

    • mergeUnknownFields

      public final BufferedAdminSink.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<BufferedAdminSink.Builder>