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

Class BufferedAdminSink

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.tap.v3.BufferedAdminSink
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BufferedAdminSinkOrBuilder, Serializable
public final class BufferedAdminSink extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BufferedAdminSink.Builder
    BufferedAdminSink configures a tap output to collect traces without returning them until one of multiple criteria are satisfied.

    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
    MAX_TRACES_FIELD_NUMBER
     
    static final int
    TIMEOUT_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)
     
    static BufferedAdminSink
    getDefaultInstance()
     
    BufferedAdminSink
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getMaxTraces()
    Stop collecting traces when the specified number are collected.
    com.google.protobuf.Parser<BufferedAdminSink>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.Duration
    getTimeout()
    Acts as a fallback to prevent the client from waiting for long periods of time.
    com.google.protobuf.DurationOrBuilder
    getTimeoutOrBuilder()
    Acts as a fallback to prevent the client from waiting for long periods of time.
    int
    hashCode()
     
    boolean
    hasTimeout()
    Acts as a fallback to prevent the client from waiting for long periods of time.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BufferedAdminSink.Builder
    newBuilder()
     
    static BufferedAdminSink.Builder
    newBuilder(BufferedAdminSink prototype)
     
    BufferedAdminSink.Builder
    newBuilderForType()
     
    protected BufferedAdminSink.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static BufferedAdminSink
    parseDelimitedFrom(InputStream input)
     
    static BufferedAdminSink
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BufferedAdminSink
    parseFrom(byte[] data)
     
    static BufferedAdminSink
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BufferedAdminSink
    parseFrom(com.google.protobuf.ByteString data)
     
    static BufferedAdminSink
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BufferedAdminSink
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BufferedAdminSink
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BufferedAdminSink
    parseFrom(InputStream input)
     
    static BufferedAdminSink
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BufferedAdminSink
    parseFrom(ByteBuffer data)
     
    static BufferedAdminSink
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BufferedAdminSink>
    parser()
     
    BufferedAdminSink.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

  • 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

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

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

    • 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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static BufferedAdminSink parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BufferedAdminSink.Builder newBuilder()

    • newBuilder

      public static BufferedAdminSink.Builder newBuilder(BufferedAdminSink prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BufferedAdminSink getDefaultInstance()

    • parser

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

    • getParserForType

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