Class DogStatsdSink

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DogStatsdSinkOrBuilder, java.io.Serializable

    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:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DogStatsdSink.Builder
      Stats configuration proto schema for built-in ``envoy.stat_sinks.dog_statsd`` sink.
      static class  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 extends java.lang.Object>, 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
    • Constructor Summary

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

      • bitField0_

        private int bitField0_
      • dogStatsdSpecifierCase_

        private int dogStatsdSpecifierCase_
      • dogStatsdSpecifier_

        private java.lang.Object dogStatsdSpecifier_
      • prefix_

        private volatile java.lang.Object prefix_
      • MAX_BYTES_PER_DATAGRAM_FIELD_NUMBER

        public static final int MAX_BYTES_PER_DATAGRAM_FIELD_NUMBER
        See Also:
        Constant Field Values
      • 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 Detail

      • DogStatsdSink

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

        private DogStatsdSink()
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • 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 java.lang.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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DogStatsdSink parseFrom​(java.nio.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​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static DogStatsdSink parseFrom​(java.io.InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static DogStatsdSink parseDelimitedFrom​(java.io.InputStream input)
                                                throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static DogStatsdSink parseDelimitedFrom​(java.io.InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public static DogStatsdSink parseFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public DogStatsdSink.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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