io.envoyproxy.envoy.config.metrics.v3.StatsdSinkOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-xds Show documentation
gRPC: XDS plugin
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/config/metrics/v3/stats.proto

// Protobuf Java Version: 3.25.5
package io.envoyproxy.envoy.config.metrics.v3;

public interface StatsdSinkOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.config.metrics.v3.StatsdSink)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   * @return Whether the address field is set.
   */
  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;
   * @return The address.
   */
  io.envoyproxy.envoy.config.core.v3.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;
   */
  io.envoyproxy.envoy.config.core.v3.AddressOrBuilder getAddressOrBuilder();

  /**
   *    * 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;
   * @return Whether the tcpClusterName field is set.
   */
  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;
   * @return The tcpClusterName.
   */
  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;
   * @return The bytes for tcpClusterName.
   */
  com.google.protobuf.ByteString
      getTcpClusterNameBytes();

  /**
   *    * 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;
   * @return The prefix.
   */
  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;
   * @return The bytes for prefix.
   */
  com.google.protobuf.ByteString
      getPrefixBytes();

  io.envoyproxy.envoy.config.metrics.v3.StatsdSink.StatsdSpecifierCase getStatsdSpecifierCase();
}