com.google.api

Interface MetricDescriptorOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

MetricDescriptor, MetricDescriptor.Builder

public interface MetricDescriptorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() A detailed description of the metric, which can be used in documentation.
com.google.protobuf.ByteString	getDescriptionBytes() 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.
com.google.protobuf.ByteString	getDisplayNameBytes() A concise name for the metric, which can be displayed in user interfaces.
LabelDescriptor	getLabels(int index) The set of labels that can be used to describe a specific instance of this metric type.
int	getLabelsCount() The set of labels that can be used to describe a specific instance of this metric type.
java.util.List<LabelDescriptor>	getLabelsList() The set of labels that can be used to describe a specific instance of this metric type.
LabelDescriptorOrBuilder	getLabelsOrBuilder(int index) The set of labels that can be used to describe a specific instance of this metric type.
java.util.List<? extends LabelDescriptorOrBuilder>	getLabelsOrBuilderList() The set of labels that can be used to describe a specific instance of this metric type.
MetricDescriptor.MetricKind	getMetricKind() Whether the metric records instantaneous values, changes to a value, etc.
int	getMetricKindValue() Whether the metric records instantaneous values, changes to a value, etc.
java.lang.String	getName() Resource name.
com.google.protobuf.ByteString	getNameBytes() Resource name.
java.lang.String	getType() The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`.
com.google.protobuf.ByteString	getTypeBytes() The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`.
java.lang.String	getUnit() The unit in which the metric value is reported.
com.google.protobuf.ByteString	getUnitBytes() The unit in which the metric value is reported.
MetricDescriptor.ValueType	getValueType() Whether the measurement is an integer, a floating-point number, etc.
int	getValueTypeValue() Whether the measurement is an integer, a floating-point number, etc.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.String getName()

 Resource name. The format of the name may vary between different
 implementations. For examples:
     projects/{project_id}/metricDescriptors/{type=**}
     metricDescriptors/{type=**}
 

optional string name = 1;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Resource name. The format of the name may vary between different
 implementations. For examples:
     projects/{project_id}/metricDescriptors/{type=**}
     metricDescriptors/{type=**}
 

optional string name = 1;

getType

java.lang.String getType()

 The metric type including a DNS name prefix, for example
 `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
 should use a natural hierarchical grouping such as the following:
     compute.googleapis.com/instance/cpu/utilization
     compute.googleapis.com/instance/disk/read_ops_count
     compute.googleapis.com/instance/network/received_bytes_count
 Note that if the metric type changes, the monitoring data will be
 discontinued, and anything depends on it will break, such as monitoring
 dashboards, alerting rules and quota limits. Therefore, once a metric has
 been published, its type should be immutable.
 

optional string type = 8;

getTypeBytes

com.google.protobuf.ByteString getTypeBytes()

 The metric type including a DNS name prefix, for example
 `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
 should use a natural hierarchical grouping such as the following:
     compute.googleapis.com/instance/cpu/utilization
     compute.googleapis.com/instance/disk/read_ops_count
     compute.googleapis.com/instance/network/received_bytes_count
 Note that if the metric type changes, the monitoring data will be
 discontinued, and anything depends on it will break, such as monitoring
 dashboards, alerting rules and quota limits. Therefore, once a metric has
 been published, its type should be immutable.
 

optional string type = 8;

getLabelsList

java.util.List<LabelDescriptor> getLabelsList()

 The set of labels that can be used to describe a specific instance of this
 metric type. For example, the
 `compute.googleapis.com/instance/network/received_bytes_count` metric type
 has a label, `loadbalanced`, that specifies whether the traffic was
 received through a load balanced IP address.
 

repeated .google.api.LabelDescriptor labels = 2;

getLabels

LabelDescriptor getLabels(int index)

 The set of labels that can be used to describe a specific instance of this
 metric type. For example, the
 `compute.googleapis.com/instance/network/received_bytes_count` metric type
 has a label, `loadbalanced`, that specifies whether the traffic was
 received through a load balanced IP address.
 

repeated .google.api.LabelDescriptor labels = 2;

getLabelsCount

int getLabelsCount()

 The set of labels that can be used to describe a specific instance of this
 metric type. For example, the
 `compute.googleapis.com/instance/network/received_bytes_count` metric type
 has a label, `loadbalanced`, that specifies whether the traffic was
 received through a load balanced IP address.
 

repeated .google.api.LabelDescriptor labels = 2;

getLabelsOrBuilderList

java.util.List<? extends LabelDescriptorOrBuilder> getLabelsOrBuilderList()

 The set of labels that can be used to describe a specific instance of this
 metric type. For example, the
 `compute.googleapis.com/instance/network/received_bytes_count` metric type
 has a label, `loadbalanced`, that specifies whether the traffic was
 received through a load balanced IP address.
 

repeated .google.api.LabelDescriptor labels = 2;

getLabelsOrBuilder

LabelDescriptorOrBuilder getLabelsOrBuilder(int index)

 The set of labels that can be used to describe a specific instance of this
 metric type. For example, the
 `compute.googleapis.com/instance/network/received_bytes_count` metric type
 has a label, `loadbalanced`, that specifies whether the traffic was
 received through a load balanced IP address.
 

repeated .google.api.LabelDescriptor labels = 2;

getMetricKindValue

int getMetricKindValue()

 Whether the metric records instantaneous values, changes to a value, etc.
 

optional .google.api.MetricDescriptor.MetricKind metric_kind = 3;

getMetricKind

MetricDescriptor.MetricKind getMetricKind()

 Whether the metric records instantaneous values, changes to a value, etc.
 

optional .google.api.MetricDescriptor.MetricKind metric_kind = 3;

getValueTypeValue

int getValueTypeValue()

 Whether the measurement is an integer, a floating-point number, etc.
 

optional .google.api.MetricDescriptor.ValueType value_type = 4;

getValueType

MetricDescriptor.ValueType getValueType()

 Whether the measurement is an integer, a floating-point number, etc.
 

optional .google.api.MetricDescriptor.ValueType value_type = 4;

getUnit

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`     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 includes the dimensionless unit `1`, such as `1/s`.
 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 '}'.
 

optional string unit = 5;

getUnitBytes

com.google.protobuf.ByteString getUnitBytes()

 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 includes the dimensionless unit `1`, such as `1/s`.
 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 '}'.
 

optional string unit = 5;

getDescription

java.lang.String getDescription()

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

optional string description = 6;

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

optional string description = 6;

getDisplayName

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".
 

optional string display_name = 7;

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 A concise name for the metric, which can be displayed in user interfaces.
 Use sentence case without an ending period, for example "Request count".
 

optional string display_name = 7;