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
orexternal.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
andvalue_type
might not be supported.- valueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- unit
The unit in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. 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 aUNIT
and is equivalent to1
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 in1/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()
- Alphabetic
- By Inheritance
- MetricDescriptor
- Product
- Equals
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
orexternal.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
andvalue_type
might not be supported.- valueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- unit
The unit in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. 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 aUNIT
and is equivalent to1
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 in1/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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllLabels(__vs: Iterable[LabelDescriptor]): MetricDescriptor
- def addLabels(__vs: LabelDescriptor*): MetricDescriptor
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearLabels: MetricDescriptor
- def clearMetadata: MetricDescriptor
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
companion: MetricDescriptor.type
- Definition Classes
- MetricDescriptor → GeneratedMessage
- val description: String
- def discardUnknownFields: MetricDescriptor
- val displayName: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- MetricDescriptor → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- MetricDescriptor → GeneratedMessage
- def getMetadata: MetricDescriptorMetadata
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val labels: Seq[LabelDescriptor]
- val launchStage: LaunchStage
- val metadata: Option[MetricDescriptorMetadata]
- val metricKind: MetricKind
- val name: String
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
serializedSize: Int
- Definition Classes
- MetricDescriptor → GeneratedMessage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
-
final
def
toByteString: ByteString
- Definition Classes
- GeneratedMessage
-
final
def
toPMessage: PMessage
- Definition Classes
- GeneratedMessage
-
def
toProtoString: String
- Definition Classes
- MetricDescriptor → GeneratedMessage
- val type: String
- val unit: String
- val unknownFields: UnknownFieldSet
-
def
update(ms: (Lens[MetricDescriptor, MetricDescriptor]) ⇒ Mutation[MetricDescriptor]*): MetricDescriptor
- Definition Classes
- Updatable
- val valueType: ValueTypeEnum
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withDescription(__v: String): MetricDescriptor
- def withDisplayName(__v: String): MetricDescriptor
- def withLabels(__v: Seq[LabelDescriptor]): MetricDescriptor
- def withLaunchStage(__v: LaunchStage): MetricDescriptor
- def withMetadata(__v: MetricDescriptorMetadata): MetricDescriptor
- def withMetricKind(__v: MetricKind): MetricDescriptor
- def withName(__v: String): MetricDescriptor
- def withType(__v: String): MetricDescriptor
- def withUnit(__v: String): MetricDescriptor
- def withUnknownFields(__v: UnknownFieldSet): MetricDescriptor
- def withValueType(__v: ValueTypeEnum): MetricDescriptor
-
final
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- MetricDescriptor → GeneratedMessage
-
final
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage