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

Class StatsdSink.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StatsdSinkOrBuilder, java.lang.Cloneable
    Enclosing class:
    StatsdSink
    public static final class StatsdSink.Builder
extends com.google.protobuf.GeneratedMessage.Builder<StatsdSink.Builder>
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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Builder()  
      private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      StatsdSink build()  
      StatsdSink buildPartial()  
      private void buildPartial0​(StatsdSink result)  
      private void buildPartialOneofs​(StatsdSink result)  
      StatsdSink.Builder clear()  
      StatsdSink.Builder clearAddress()
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      StatsdSink.Builder clearPrefix()
      Optional custom prefix for StatsdSink.
      StatsdSink.Builder clearStatsdSpecifier()  
      StatsdSink.Builder clearTcpClusterName()
      The name of a cluster that is running a TCP `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      Address getAddress()
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      Address.Builder getAddressBuilder()
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      private com.google.protobuf.SingleFieldBuilder<Address,​Address.Builder,​AddressOrBuilder> getAddressFieldBuilder()
      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.
      StatsdSink getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.lang.String getPrefix()
      Optional custom prefix for StatsdSink.
      com.google.protobuf.ByteString getPrefixBytes()
      Optional custom prefix for StatsdSink.
      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.
      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()  
      StatsdSink.Builder mergeAddress​(Address value)
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      StatsdSink.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      StatsdSink.Builder mergeFrom​(com.google.protobuf.Message other)  
      StatsdSink.Builder mergeFrom​(StatsdSink other)  
      StatsdSink.Builder setAddress​(Address value)
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      StatsdSink.Builder setAddress​(Address.Builder builderForValue)
      The UDP address of a running `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      StatsdSink.Builder setPrefix​(java.lang.String value)
      Optional custom prefix for StatsdSink.
      StatsdSink.Builder setPrefixBytes​(com.google.protobuf.ByteString value)
      Optional custom prefix for StatsdSink.
      StatsdSink.Builder setTcpClusterName​(java.lang.String value)
      The name of a cluster that is running a TCP `statsd <https://github.com/etsy/statsd>`_ compliant listener.
      StatsdSink.Builder setTcpClusterNameBytes​(com.google.protobuf.ByteString value)
      The name of a cluster that is running a TCP `statsd <https://github.com/etsy/statsd>`_ compliant listener.

      • Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

        addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • statsdSpecifierCase_

        private int statsdSpecifierCase_

      • statsdSpecifier_

        private java.lang.Object statsdSpecifier_

      • bitField0_

        private int bitField0_

      • prefix_

        private java.lang.Object prefix_

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)

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

      • clear

        public StatsdSink.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessage.Builder<StatsdSink.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StatsdSink.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • buildPartial0

        private void buildPartial0​(StatsdSink result)

      • buildPartialOneofs

        private void buildPartialOneofs​(StatsdSink result)

      • mergeFrom

        public StatsdSink.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StatsdSink.Builder>

      • isInitialized

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

      • mergeFrom

        public StatsdSink.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StatsdSink.Builder>
        Throws:
        java.io.IOException

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

      • setAddress

        public StatsdSink.Builder setAddress​(Address value)
         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;

      • setAddress

        public StatsdSink.Builder setAddress​(Address.Builder builderForValue)
         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;

      • mergeAddress

        public StatsdSink.Builder mergeAddress​(Address value)
         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;

      • clearAddress

        public StatsdSink.Builder clearAddress()
         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;

      • getAddressBuilder

        public Address.Builder getAddressBuilder()
         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;

      • 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

      • getAddressFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<Address,​Address.Builder,​AddressOrBuilder> getAddressFieldBuilder()
         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;

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

      • setTcpClusterName

        public StatsdSink.Builder setTcpClusterName​(java.lang.String value)
         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;
        Parameters:
        value - The tcpClusterName to set.
        Returns:
        This builder for chaining.

      • clearTcpClusterName

        public StatsdSink.Builder clearTcpClusterName()
         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;
        Returns:
        This builder for chaining.

      • setTcpClusterNameBytes

        public StatsdSink.Builder setTcpClusterNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for tcpClusterName to set.
        Returns:
        This builder for chaining.

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

      • setPrefix

        public StatsdSink.Builder setPrefix​(java.lang.String value)
         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;
        Parameters:
        value - The prefix to set.
        Returns:
        This builder for chaining.

      • clearPrefix

        public StatsdSink.Builder clearPrefix()
         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;
        Returns:
        This builder for chaining.

      • setPrefixBytes

        public StatsdSink.Builder setPrefixBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for prefix to set.
        Returns:
        This builder for chaining.