Class StatsdSink

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

    public final class StatsdSink
    extends com.google.protobuf.GeneratedMessage
    implements StatsdSinkOrBuilder
     Stats configuration proto schema for built-in ``envoy.stat_sinks.statsd`` sink. This sink does not support
     tagged metrics.
     [#extension: envoy.stat_sinks.statsd]
     
    Protobuf type envoy.config.metrics.v3.StatsdSink
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  StatsdSink.Builder
      Stats configuration proto schema for built-in ``envoy.stat_sinks.statsd`` sink.
      static class  StatsdSink.StatsdSpecifierCase  
      • 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 StatsdSink()  
      private StatsdSink​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      Address getAddress()
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      AddressOrBuilder getAddressOrBuilder()
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      static StatsdSink getDefaultInstance()  
      StatsdSink getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<StatsdSink> getParserForType()  
      java.lang.String getPrefix()
      Optional custom prefix for StatsdSink.
      com.google.protobuf.ByteString getPrefixBytes()
      Optional custom prefix for StatsdSink.
      int getSerializedSize()  
      StatsdSink.StatsdSpecifierCase getStatsdSpecifierCase()  
      java.lang.String getTcpClusterName()
      The name of a cluster that is running a TCP `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      com.google.protobuf.ByteString getTcpClusterNameBytes()
      The name of a cluster that is running a TCP `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      boolean hasAddress()
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      int hashCode()  
      boolean hasTcpClusterName()
      The name of a cluster that is running a TCP `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static StatsdSink.Builder newBuilder()  
      static StatsdSink.Builder newBuilder​(StatsdSink prototype)  
      StatsdSink.Builder newBuilderForType()  
      protected StatsdSink.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static StatsdSink parseDelimitedFrom​(java.io.InputStream input)  
      static StatsdSink parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StatsdSink parseFrom​(byte[] data)  
      static StatsdSink parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StatsdSink parseFrom​(com.google.protobuf.ByteString data)  
      static StatsdSink parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StatsdSink parseFrom​(com.google.protobuf.CodedInputStream input)  
      static StatsdSink parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StatsdSink parseFrom​(java.io.InputStream input)  
      static StatsdSink parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StatsdSink parseFrom​(java.nio.ByteBuffer data)  
      static StatsdSink parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<StatsdSink> parser()  
      StatsdSink.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, 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, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Field Detail

      • statsdSpecifierCase_

        private int statsdSpecifierCase_
      • statsdSpecifier_

        private java.lang.Object statsdSpecifier_
      • TCP_CLUSTER_NAME_FIELD_NUMBER

        public static final int TCP_CLUSTER_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • prefix_

        private volatile java.lang.Object prefix_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final StatsdSink DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<StatsdSink> PARSER
    • Constructor Detail

      • StatsdSink

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

        private StatsdSink()
    • 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 `statsd <https://github.com/etsy/statsd>`_
         compliant listener. If specified, statistics will be flushed to this
         address.
         
        .envoy.config.core.v3.Address address = 1;
        Specified by:
        hasAddress in interface StatsdSinkOrBuilder
        Returns:
        Whether the address field is set.
      • getAddress

        public Address getAddress()
         The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
         compliant listener. If specified, statistics will be flushed to this
         address.
         
        .envoy.config.core.v3.Address address = 1;
        Specified by:
        getAddress in interface StatsdSinkOrBuilder
        Returns:
        The address.
      • getAddressOrBuilder

        public AddressOrBuilder getAddressOrBuilder()
         The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
         compliant listener. If specified, statistics will be flushed to this
         address.
         
        .envoy.config.core.v3.Address address = 1;
        Specified by:
        getAddressOrBuilder in interface StatsdSinkOrBuilder
      • hasTcpClusterName

        public boolean hasTcpClusterName()
         The name of a cluster that is running a TCP `statsd
         <https://github.com/etsy/statsd>`_ compliant listener. If specified,
         Envoy will connect to this cluster to flush statistics.
         
        string tcp_cluster_name = 2;
        Specified by:
        hasTcpClusterName in interface StatsdSinkOrBuilder
        Returns:
        Whether the tcpClusterName field is set.
      • getTcpClusterName

        public java.lang.String getTcpClusterName()
         The name of a cluster that is running a TCP `statsd
         <https://github.com/etsy/statsd>`_ compliant listener. If specified,
         Envoy will connect to this cluster to flush statistics.
         
        string tcp_cluster_name = 2;
        Specified by:
        getTcpClusterName in interface StatsdSinkOrBuilder
        Returns:
        The tcpClusterName.
      • getTcpClusterNameBytes

        public com.google.protobuf.ByteString getTcpClusterNameBytes()
         The name of a cluster that is running a TCP `statsd
         <https://github.com/etsy/statsd>`_ compliant listener. If specified,
         Envoy will connect to this cluster to flush statistics.
         
        string tcp_cluster_name = 2;
        Specified by:
        getTcpClusterNameBytes in interface StatsdSinkOrBuilder
        Returns:
        The bytes for tcpClusterName.
      • getPrefix

        public java.lang.String getPrefix()
         Optional custom prefix for StatsdSink. If
         specified, this will override the default prefix.
         For example:
        
         .. code-block:: json
        
         {
         "prefix" : "envoy-prod"
         }
        
         will change emitted stats to
        
         .. code-block:: cpp
        
         envoy-prod.test_counter:1|c
         envoy-prod.test_timer:5|ms
        
         Note that the default prefix, "envoy", will be used if a prefix is not
         specified.
        
         Stats with default prefix:
        
         .. code-block:: cpp
        
         envoy.test_counter:1|c
         envoy.test_timer:5|ms
         
        string prefix = 3;
        Specified by:
        getPrefix in interface StatsdSinkOrBuilder
        Returns:
        The prefix.
      • getPrefixBytes

        public com.google.protobuf.ByteString getPrefixBytes()
         Optional custom prefix for StatsdSink. If
         specified, this will override the default prefix.
         For example:
        
         .. code-block:: json
        
         {
         "prefix" : "envoy-prod"
         }
        
         will change emitted stats to
        
         .. code-block:: cpp
        
         envoy-prod.test_counter:1|c
         envoy-prod.test_timer:5|ms
        
         Note that the default prefix, "envoy", will be used if a prefix is not
         specified.
        
         Stats with default prefix:
        
         .. code-block:: cpp
        
         envoy.test_counter:1|c
         envoy.test_timer:5|ms
         
        string prefix = 3;
        Specified by:
        getPrefixBytes in interface StatsdSinkOrBuilder
        Returns:
        The bytes for prefix.
      • 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 StatsdSink parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static StatsdSink parseFrom​(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static StatsdSink parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static StatsdSink parseFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

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

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

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

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

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

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

        protected StatsdSink.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getDefaultInstance

        public static StatsdSink getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<StatsdSink> parser()
      • getParserForType

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