Package io.envoyproxy.envoy.config.metrics.v3

Class DogStatsdSink

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.metrics.v3.DogStatsdSink
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DogStatsdSinkOrBuilder, Serializable
@Generated public final class DogStatsdSink extends com.google.protobuf.GeneratedMessage implements DogStatsdSinkOrBuilder
 Stats configuration proto schema for built-in ``envoy.stat_sinks.dog_statsd`` sink.
 The sink emits stats with `DogStatsD <https://docs.datadoghq.com/guides/dogstatsd/>`_
 compatible tags. Tags are configurable via :ref:`StatsConfig
 <envoy_v3_api_msg_config.metrics.v3.StatsConfig>`.
 [#extension: envoy.stat_sinks.dog_statsd]
Protobuf type envoy.config.metrics.v3.DogStatsdSink
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DogStatsdSink.Builder
    Stats configuration proto schema for built-in ``envoy.stat_sinks.dog_statsd`` sink.
    static enum 
    DogStatsdSink.DogStatsdSpecifierCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    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
    ADDRESS_FIELD_NUMBER
     
    private int
    bitField0_
     
    private static final DogStatsdSink
    DEFAULT_INSTANCE
     
    private Object
    dogStatsdSpecifier_
     
    private int
    dogStatsdSpecifierCase_
     
    static final int
    MAX_BYTES_PER_DATAGRAM_FIELD_NUMBER
     
    private com.google.protobuf.UInt64Value
    maxBytesPerDatagram_
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<DogStatsdSink>
    PARSER
     
    private Object
    prefix_
     
    static final int
    PREFIX_FIELD_NUMBER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    DogStatsdSink()
     
    private
    DogStatsdSink(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Address
    getAddress()
    The UDP address of a running DogStatsD compliant listener.
    AddressOrBuilder
    getAddressOrBuilder()
    The UDP address of a running DogStatsD compliant listener.
    static DogStatsdSink
    getDefaultInstance()
     
    DogStatsdSink
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    DogStatsdSink.DogStatsdSpecifierCase
    getDogStatsdSpecifierCase()
     
    com.google.protobuf.UInt64Value
    getMaxBytesPerDatagram()
    Optional max datagram size to use when sending UDP messages.
    com.google.protobuf.UInt64ValueOrBuilder
    getMaxBytesPerDatagramOrBuilder()
    Optional max datagram size to use when sending UDP messages.
    com.google.protobuf.Parser<DogStatsdSink>
    getParserForType()
     
    String
    getPrefix()
    Optional custom metric name prefix.
    com.google.protobuf.ByteString
    getPrefixBytes()
    Optional custom metric name prefix.
    int
    getSerializedSize()
     
    boolean
    hasAddress()
    The UDP address of a running DogStatsD compliant listener.
    int
    hashCode()
     
    boolean
    hasMaxBytesPerDatagram()
    Optional max datagram size to use when sending UDP messages.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DogStatsdSink.Builder
    newBuilder()
     
    static DogStatsdSink.Builder
    newBuilder(DogStatsdSink prototype)
     
    DogStatsdSink.Builder
    newBuilderForType()
     
    protected DogStatsdSink.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DogStatsdSink
    parseDelimitedFrom(InputStream input)
     
    static DogStatsdSink
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DogStatsdSink
    parseFrom(byte[] data)
     
    static DogStatsdSink
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DogStatsdSink
    parseFrom(com.google.protobuf.ByteString data)
     
    static DogStatsdSink
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DogStatsdSink
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DogStatsdSink
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DogStatsdSink
    parseFrom(InputStream input)
     
    static DogStatsdSink
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DogStatsdSink
    parseFrom(ByteBuffer data)
     
    static DogStatsdSink
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DogStatsdSink>
    parser()
     
    DogStatsdSink.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • dogStatsdSpecifierCase_

      private int dogStatsdSpecifierCase_

    • dogStatsdSpecifier_

      private Object dogStatsdSpecifier_

    • ADDRESS_FIELD_NUMBER

      public static final int ADDRESS_FIELD_NUMBER
      See Also:

    • PREFIX_FIELD_NUMBER

      public static final int PREFIX_FIELD_NUMBER
      See Also:

    • prefix_

      private volatile Object prefix_

    • MAX_BYTES_PER_DATAGRAM_FIELD_NUMBER

      public static final int MAX_BYTES_PER_DATAGRAM_FIELD_NUMBER
      See Also:

    • maxBytesPerDatagram_

      private com.google.protobuf.UInt64Value maxBytesPerDatagram_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final DogStatsdSink DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<DogStatsdSink> PARSER

  • Constructor Details

    • DogStatsdSink

      private DogStatsdSink(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • DogStatsdSink

      private DogStatsdSink()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDogStatsdSpecifierCase

      public DogStatsdSink.DogStatsdSpecifierCase getDogStatsdSpecifierCase()
      Specified by:
      getDogStatsdSpecifierCase in interface DogStatsdSinkOrBuilder

    • hasAddress

      public boolean hasAddress()
       The UDP address of a running DogStatsD compliant listener. If specified,
 statistics will be flushed to this address.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      hasAddress in interface DogStatsdSinkOrBuilder
      Returns:
      Whether the address field is set.

    • getAddress

      public Address getAddress()
       The UDP address of a running DogStatsD compliant listener. If specified,
 statistics will be flushed to this address.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      getAddress in interface DogStatsdSinkOrBuilder
      Returns:
      The address.

    • getAddressOrBuilder

      public AddressOrBuilder getAddressOrBuilder()
       The UDP address of a running DogStatsD compliant listener. If specified,
 statistics will be flushed to this address.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      getAddressOrBuilder in interface DogStatsdSinkOrBuilder

    • getPrefix

      public String getPrefix()
       Optional custom metric name prefix. See :ref:`StatsdSink's prefix field
 <envoy_v3_api_field_config.metrics.v3.StatsdSink.prefix>` for more details.
      string prefix = 3;
      Specified by:
      getPrefix in interface DogStatsdSinkOrBuilder
      Returns:
      The prefix.

    • getPrefixBytes

      public com.google.protobuf.ByteString getPrefixBytes()
       Optional custom metric name prefix. See :ref:`StatsdSink's prefix field
 <envoy_v3_api_field_config.metrics.v3.StatsdSink.prefix>` for more details.
      string prefix = 3;
      Specified by:
      getPrefixBytes in interface DogStatsdSinkOrBuilder
      Returns:
      The bytes for prefix.

    • hasMaxBytesPerDatagram

      public boolean hasMaxBytesPerDatagram()
       Optional max datagram size to use when sending UDP messages. By default Envoy
 will emit one metric per datagram. By specifying a max-size larger than a single
 metric, Envoy will emit multiple, new-line separated metrics. The max datagram
 size should not exceed your network's MTU.

 Note that this value may not be respected if smaller than a single metric.
      .google.protobuf.UInt64Value max_bytes_per_datagram = 4 [(.validate.rules) = { ... }
      Specified by:
      hasMaxBytesPerDatagram in interface DogStatsdSinkOrBuilder
      Returns:
      Whether the maxBytesPerDatagram field is set.

    • getMaxBytesPerDatagram

      public com.google.protobuf.UInt64Value getMaxBytesPerDatagram()
       Optional max datagram size to use when sending UDP messages. By default Envoy
 will emit one metric per datagram. By specifying a max-size larger than a single
 metric, Envoy will emit multiple, new-line separated metrics. The max datagram
 size should not exceed your network's MTU.

 Note that this value may not be respected if smaller than a single metric.
      .google.protobuf.UInt64Value max_bytes_per_datagram = 4 [(.validate.rules) = { ... }
      Specified by:
      getMaxBytesPerDatagram in interface DogStatsdSinkOrBuilder
      Returns:
      The maxBytesPerDatagram.

    • getMaxBytesPerDatagramOrBuilder

      public com.google.protobuf.UInt64ValueOrBuilder getMaxBytesPerDatagramOrBuilder()
       Optional max datagram size to use when sending UDP messages. By default Envoy
 will emit one metric per datagram. By specifying a max-size larger than a single
 metric, Envoy will emit multiple, new-line separated metrics. The max datagram
 size should not exceed your network's MTU.

 Note that this value may not be respected if smaller than a single metric.
      .google.protobuf.UInt64Value max_bytes_per_datagram = 4 [(.validate.rules) = { ... }
      Specified by:
      getMaxBytesPerDatagramOrBuilder in interface DogStatsdSinkOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DogStatsdSink.Builder newBuilder()

    • newBuilder

      public static DogStatsdSink.Builder newBuilder(DogStatsdSink prototype)

    • toBuilder

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

    • newBuilderForType

      protected DogStatsdSink.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DogStatsdSink getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DogStatsdSink> 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.GeneratedMessage

    • getDefaultInstanceForType

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