MetricDescriptor (Stackdriver Monitoring API v3 (Rev. 471) 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 Stackdriver 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.
`MetricDescriptorMetadata`	`getMetadata()` Optional.
`java.lang.String`	`getMetricKind()` Whether the metric records instantaneous values, changes to a value, etc.
`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 unit 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`	`setMetadata(MetricDescriptorMetadata metadata)` Optional.
`MetricDescriptor`	`setMetricKind(java.lang.String metricKind)` Whether the metric records instantaneous values, changes to a value, etc.
`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 unit 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
  - 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
  - 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 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 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)GrammarThe 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.
    
    Returns:
    
    value or null for none
  - setUnit
```
public MetricDescriptor setUnit(java.lang.String 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 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)GrammarThe 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.
    
    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

Stackdriver Monitoring API v3 (revision 471)

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

getMetadata

setMetadata

getMetricKind

setMetricKind

getName

setName

getType

setType

getUnit

setUnit

getValueType

setValueType

set

clone