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

Class StatsdSink

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.metrics.v3.StatsdSink
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StatsdSinkOrBuilder, 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StatsdSink.Builder
    Stats configuration proto schema for built-in ``envoy.stat_sinks.statsd`` sink.
    static enum 
    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>, 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 static final StatsdSink
    DEFAULT_INSTANCE
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<StatsdSink>
    PARSER
     
    private Object
    prefix_
     
    static final int
    PREFIX_FIELD_NUMBER
     
    private static final long
    serialVersionUID
     
    private Object
    statsdSpecifier_
     
    private int
    statsdSpecifierCase_
     
    static final int
    TCP_CLUSTER_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, 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
    StatsdSink()
     
    private
    StatsdSink(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 `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 final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<StatsdSink>
    getParserForType()
     
    String
    getPrefix()
    Optional custom prefix for StatsdSink.
    com.google.protobuf.ByteString
    getPrefixBytes()
    Optional custom prefix for StatsdSink.
    int
    getSerializedSize()
     
    StatsdSink.StatsdSpecifierCase
    getStatsdSpecifierCase()
     
    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()
     
    final 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(InputStream input)
     
    static StatsdSink
    parseDelimitedFrom(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(InputStream input)
     
    static StatsdSink
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatsdSink
    parseFrom(ByteBuffer data)
     
    static StatsdSink
    parseFrom(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 Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • statsdSpecifierCase_

      private int statsdSpecifierCase_

    • statsdSpecifier_

      private Object statsdSpecifier_

    • ADDRESS_FIELD_NUMBER

      public static final int ADDRESS_FIELD_NUMBER
      See Also:

    • TCP_CLUSTER_NAME_FIELD_NUMBER

      public static final int TCP_CLUSTER_NAME_FIELD_NUMBER
      See Also:

    • PREFIX_FIELD_NUMBER

      public static final int PREFIX_FIELD_NUMBER
      See Also:

    • prefix_

      private volatile 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 Details

    • StatsdSink

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

    • StatsdSink

      private StatsdSink()

  • Method Details

    • 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

    • getStatsdSpecifierCase

      public StatsdSink.StatsdSpecifierCase getStatsdSpecifierCase()
      Specified by:
      getStatsdSpecifierCase in interface StatsdSinkOrBuilder

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

    • parseFrom

      public static StatsdSink parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StatsdSink.Builder newBuilder()

    • newBuilder

      public static StatsdSink.Builder newBuilder(StatsdSink prototype)

    • 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