MetricDescriptor (Cloud Monitoring API v3 (Rev. 540) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.monitoring.v3.model.MetricDescriptor

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class MetricDescriptor
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

MetricDescriptor()

Constructors
Constructor and Description
`MetricDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricDescriptor`	`clone()`
`java.lang.String`	`getDescription()` A detailed description of the metric, which can be used in documentation.
`java.lang.String`	`getDisplayName()` A concise name for the metric, which can be displayed in user interfaces.
`java.util.List<LabelDescriptor>`	`getLabels()` The set of labels that can be used to describe a specific instance of this metric type.
`java.lang.String`	`getLaunchStage()` Optional.
`MetricDescriptorMetadata`	`getMetadata()` Optional.
`java.lang.String`	`getMetricKind()` Whether the metric records instantaneous values, changes to a value, etc.
`java.util.List<java.lang.String>`	`getMonitoredResourceTypes()` Read-only.
`java.lang.String`	`getName()` The resource name of the metric descriptor.
`java.lang.String`	`getType()` The metric type, including its DNS name prefix.
`java.lang.String`	`getUnit()` The units in which the metric value is reported.
`java.lang.String`	`getValueType()` Whether the measurement is an integer, a floating-point number, etc.
`MetricDescriptor`	`set(java.lang.String fieldName, java.lang.Object value)`
`MetricDescriptor`	`setDescription(java.lang.String description)` A detailed description of the metric, which can be used in documentation.
`MetricDescriptor`	`setDisplayName(java.lang.String displayName)` A concise name for the metric, which can be displayed in user interfaces.
`MetricDescriptor`	`setLabels(java.util.List<LabelDescriptor> labels)` The set of labels that can be used to describe a specific instance of this metric type.
`MetricDescriptor`	`setLaunchStage(java.lang.String launchStage)` Optional.
`MetricDescriptor`	`setMetadata(MetricDescriptorMetadata metadata)` Optional.
`MetricDescriptor`	`setMetricKind(java.lang.String metricKind)` Whether the metric records instantaneous values, changes to a value, etc.
`MetricDescriptor`	`setMonitoredResourceTypes(java.util.List<java.lang.String> monitoredResourceTypes)` Read-only.
`MetricDescriptor`	`setName(java.lang.String name)` The resource name of the metric descriptor.
`MetricDescriptor`	`setType(java.lang.String type)` The metric type, including its DNS name prefix.
`MetricDescriptor`	`setUnit(java.lang.String unit)` The units in which the metric value is reported.
`MetricDescriptor`	`setValueType(java.lang.String valueType)` Whether the measurement is an integer, a floating-point number, etc.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - MetricDescriptor
```
public MetricDescriptor()
```
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    A detailed description of the metric, which can be used in documentation.
    
    Returns:
    
    value or null for none
  - setDescription
```
public MetricDescriptor setDescription(java.lang.String description)
```
    A detailed description of the metric, which can be used in documentation.
    
    Parameters:
    
    description - description or null for none
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public MetricDescriptor setDisplayName(java.lang.String 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.
    
    Parameters:
    
    displayName - displayName or null for none
  - getLabels
```
public java.util.List<LabelDescriptor> getLabels()
```
    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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public MetricDescriptor setLabels(java.util.List<LabelDescriptor> 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.
    
    Parameters:
    
    labels - labels or null for none
  - getLaunchStage
```
public java.lang.String getLaunchStage()
```
    Optional. The launch stage of the metric definition.
    
    Returns:
    
    value or null for none
  - setLaunchStage
```
public MetricDescriptor setLaunchStage(java.lang.String launchStage)
```
    Optional. The launch stage of the metric definition.
    
    Parameters:
    
    launchStage - launchStage or null for none
  - getMetadata
```
public MetricDescriptorMetadata getMetadata()
```
    Optional. Metadata which can be used to guide usage of the metric.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public MetricDescriptor setMetadata(MetricDescriptorMetadata metadata)
```
    Optional. Metadata which can be used to guide usage of the metric.
    
    Parameters:
    
    metadata - metadata or null for none
  - getMetricKind
```
public java.lang.String getMetricKind()
```
    Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
    
    Returns:
    
    value or null for none
  - setMetricKind
```
public MetricDescriptor setMetricKind(java.lang.String metricKind)
```
    Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
    
    Parameters:
    
    metricKind - metricKind or null for none
  - getMonitoredResourceTypes
```
public java.util.List<java.lang.String> getMonitoredResourceTypes()
```
    Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
    
    Returns:
    
    value or null for none
  - setMonitoredResourceTypes
```
public MetricDescriptor setMonitoredResourceTypes(java.util.List<java.lang.String> monitoredResourceTypes)
```
    Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
    
    Parameters:
    
    monitoredResourceTypes - monitoredResourceTypes or null for none
  - getName
```
public java.lang.String getName()
```
    The resource name of the metric descriptor.
    
    Returns:
    
    value or null for none
  - setName
```
public MetricDescriptor setName(java.lang.String name)
```
    The resource name of the metric descriptor.
    
    Parameters:
    
    name - name or null for none
  - getType
```
public java.lang.String getType()
```
    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"
    
    Returns:
    
    value or null for none
  - setType
```
public MetricDescriptor setType(java.lang.String 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"
    
    Parameters:
    
    type - type or null for none
  - getUnit
```
public java.lang.String getUnit()
```
    The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU- seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).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 dayPrefixes (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) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.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. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
    
    Returns:
    
    value or null for none
  - setUnit
```
public MetricDescriptor setUnit(java.lang.String unit)
```
    The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU- seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).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 dayPrefixes (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) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.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. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").
    
    Parameters:
    
    unit - unit or null for none
  - getValueType
```
public java.lang.String getValueType()
```
    Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
    
    Returns:
    
    value or null for none
  - setValueType
```
public MetricDescriptor setValueType(java.lang.String valueType)
```
    Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
    
    Parameters:
    
    valueType - valueType or null for none
  - set
```
public MetricDescriptor set(java.lang.String fieldName,
                            java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public MetricDescriptor clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Monitoring API v3 (revision 540)

Class MetricDescriptor

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

MetricDescriptor

Method Detail

getDescription

setDescription

getDisplayName

setDisplayName

getLabels

setLabels

getLaunchStage

setLaunchStage

getMetadata

setMetadata

getMetricKind

setMetricKind

getMonitoredResourceTypes

setMonitoredResourceTypes

getName

setName

getType

setType

getUnit

setUnit

getValueType

setValueType

set

clone