final case class MetricDescriptor(name: String = "", type: String = "", labels: Seq[LabelDescriptor] = _root_.scala.Seq.empty, metricKind: MetricKind = ..., valueType: ValueTypeEnum = ..., unit: String = "", description: String = "", displayName: String = "", metadata: Option[MetricDescriptorMetadata] = _root_.scala.None, launchStage: LaunchStage = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MetricDescriptor] with Product with Serializable

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()
Linear Supertypes
Product, Equals, Updatable[MetricDescriptor], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetricDescriptor
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MetricDescriptor(name: String = "", type: String = "", labels: Seq[LabelDescriptor] = _root_.scala.Seq.empty, metricKind: MetricKind = ..., valueType: ValueTypeEnum = ..., unit: String = "", description: String = "", displayName: String = "", metadata: Option[MetricDescriptorMetadata] = _root_.scala.None, launchStage: LaunchStage = ..., unknownFields: UnknownFieldSet = ...)

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllLabels(__vs: Iterable[LabelDescriptor]): MetricDescriptor
  5. def addLabels(__vs: LabelDescriptor*): MetricDescriptor
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearLabels: MetricDescriptor
  8. def clearMetadata: MetricDescriptor
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def companion: MetricDescriptor.type
    Definition Classes
    MetricDescriptor → GeneratedMessage
  11. val description: String
  12. def discardUnknownFields: MetricDescriptor
  13. val displayName: String
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    MetricDescriptor → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    MetricDescriptor → GeneratedMessage
  19. def getMetadata: MetricDescriptorMetadata
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val labels: Seq[LabelDescriptor]
  22. val launchStage: LaunchStage
  23. val metadata: Option[MetricDescriptorMetadata]
  24. val metricKind: MetricKind
  25. val name: String
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def serializedSize: Int
    Definition Classes
    MetricDescriptor → GeneratedMessage
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  32. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  33. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  34. def toProtoString: String
    Definition Classes
    MetricDescriptor → GeneratedMessage
  35. val type: String
  36. val unit: String
  37. val unknownFields: UnknownFieldSet
  38. def update(ms: (Lens[MetricDescriptor, MetricDescriptor]) ⇒ Mutation[MetricDescriptor]*): MetricDescriptor
    Definition Classes
    Updatable
  39. val valueType: ValueTypeEnum
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. def withDescription(__v: String): MetricDescriptor
  44. def withDisplayName(__v: String): MetricDescriptor
  45. def withLabels(__v: Seq[LabelDescriptor]): MetricDescriptor
  46. def withLaunchStage(__v: LaunchStage): MetricDescriptor
  47. def withMetadata(__v: MetricDescriptorMetadata): MetricDescriptor
  48. def withMetricKind(__v: MetricKind): MetricDescriptor
  49. def withName(__v: String): MetricDescriptor
  50. def withType(__v: String): MetricDescriptor
  51. def withUnit(__v: String): MetricDescriptor
  52. def withUnknownFields(__v: UnknownFieldSet): MetricDescriptor
  53. def withValueType(__v: ValueTypeEnum): MetricDescriptor
  54. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  55. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    MetricDescriptor → GeneratedMessage
  56. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[MetricDescriptor]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped