Type Members

1.  final case class Metric(type: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Metric] with Product with Serializable

   A specific metric, identified by specifying values for all of the labels of a [MetricDescriptor][google.api.MetricDescriptor].

   A specific metric, identified by specifying values for all of the labels of a [MetricDescriptor][google.api.MetricDescriptor].

   type

   An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor]. For example, custom.googleapis.com/invoice/paid/amount.

   labels

   The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.

   Annotations

   @SerialVersionUID()

2.  final case class MetricDescriptor(name: String = "", type: String = "", labels: Seq[label.LabelDescriptor] = _root_.scala.Seq.empty, metricKind: MetricKind = com.google.api.metric.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED, valueType: ValueTypeEnum = com.google.api.metric.MetricDescriptor.ValueTypeEnum.VALUE_TYPE_UNSPECIFIED, unit: String = "", description: String = "", displayName: String = "", metadata: Option[MetricDescriptorMetadata] = _root_.scala.None, launchStage: launch_stage.LaunchStage = com.google.api.launch_stage.LaunchStage.LAUNCH_STAGE_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MetricDescriptor] with Product with Serializable

   Defines a metric type and its schema.

   Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

   name

   The resource name of the metric descriptor.

   type

   The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

   labels

   The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

   metricKind

   Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

   valueType

   Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

   unit

   The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * bit bit * By byte * s second * min minute * h hour * d day **Prefixes (PREFIX)** * k kilo (10**3) * M mega (10**6) * G giga (10**9) * T tera (10**12) * P peta (10**15) * E exa (10**18) * Z zetta (10**21) * Y yotta (10**24) * m milli (10**-3) * u micro (10**-6) * n nano (10**-9) * p pico (10**-12) * f femto (10**-15) * a atto (10**-18) * z zepto (10**-21) * y yocto (10**-24) * Ki kibi (2**10) * Mi mebi (2**20) * Gi gibi (2**30) * Ti tebi (2**40) **Grammar** The grammar also includes these connectors: * / division (as an infix operator, e.g. 1/s). * . multiplication (as an infix operator, e.g. GBy.d) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * 1 represents dimensionless value 1, such as in 1/s. * % represents dimensionless value 1/100, and annotates values giving a percentage.

   description

   A detailed description of the metric, which can be used in documentation.

   displayName

   A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

   metadata

   Optional. Metadata which can be used to guide usage of the metric.

   launchStage

   Optional. The launch stage of the metric definition.

   Annotations

   @SerialVersionUID()