Class StatsdSink.Builder

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

  • Field Details

    • statsdSpecifierCase_

      private int statsdSpecifierCase_

    • statsdSpecifier_

      private Object statsdSpecifier_

    • bitField0_

      private int bitField0_

    • addressBuilder_

      private com.google.protobuf.SingleFieldBuilder<Address, Address.Builder, AddressOrBuilder> addressBuilder_

    • prefix_

      private Object prefix_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

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

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

    • mergeFrom

      public StatsdSink.Builder mergeFrom(StatsdSink other)

    • 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 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:
      IOException

    • getStatsdSpecifierCase

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

    • clearStatsdSpecifier

      public StatsdSink.Builder clearStatsdSpecifier()

    • 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

    • internalGetAddressFieldBuilder

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