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
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.
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.
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.
List<? extends LabelDescriptorOrBuilder>	getLabelsOrBuilderList() The set of labels that can be used to describe a specific instance of this metric type.
LaunchStage	getLaunchStage() Optional.
int	getLaunchStageValue() Optional.
MetricDescriptor.MetricDescriptorMetadata	getMetadata() Optional.
MetricDescriptor.MetricDescriptorMetadataOrBuilder	getMetadataOrBuilder() Optional.
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.
String	getMonitoredResourceTypes(int index) Read-only.
com.google.protobuf.ByteString	getMonitoredResourceTypesBytes(int index) Read-only.
int	getMonitoredResourceTypesCount() Read-only.
List<String>	getMonitoredResourceTypesList() Read-only.
String	getName() The resource name of the metric descriptor.
com.google.protobuf.ByteString	getNameBytes() The resource name of the metric descriptor.
String	getType() The metric type, including its DNS name prefix.
com.google.protobuf.ByteString	getTypeBytes() The metric type, including its DNS name prefix.
String	getUnit() The units in which the metric value is reported.
com.google.protobuf.ByteString	getUnitBytes() The units 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.
boolean	hasMetadata() Optional.

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

String getName()

 The resource name of the metric descriptor.
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The resource name of the metric descriptor.
 

string name = 1;

Returns:

The bytes for name.

getType

String getType()

 The metric type, including its DNS name prefix. The type is not
 URL-encoded.
 All service defined metrics must be prefixed with the service name, in the
 format of `{service name}/{relative metric name}`, such as
 `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric
 name must follow:
 * Only upper and lower-case letters, digits, '/' and underscores '_' are
   allowed.
 * The maximum number of characters allowed for the relative_metric_name is
   100.
 All user-defined metric types have the DNS name
 `custom.googleapis.com`, `external.googleapis.com`, or
 `logging.googleapis.com/user/`.
 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"
 

string type = 8;

Returns:

The type.

getTypeBytes

com.google.protobuf.ByteString getTypeBytes()

 The metric type, including its DNS name prefix. The type is not
 URL-encoded.
 All service defined metrics must be prefixed with the service name, in the
 format of `{service name}/{relative metric name}`, such as
 `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric
 name must follow:
 * Only upper and lower-case letters, digits, '/' and underscores '_' are
   allowed.
 * The maximum number of characters allowed for the relative_metric_name is
   100.
 All user-defined metric types have the DNS name
 `custom.googleapis.com`, `external.googleapis.com`, or
 `logging.googleapis.com/user/`.
 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"
 

string type = 8;

Returns:

The bytes for type.

getLabelsList

List<LabelDescriptor> getLabelsList()

 The set of labels that can be used to describe a specific
 instance of this metric type.
 The label key name must follow:
 * Only upper and lower-case letters, digits and underscores (_) are
   allowed.
 * Label name must start with a letter or digit.
 * The maximum length of a label name is 100 characters.
 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.
 

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.
 The label key name must follow:
 * Only upper and lower-case letters, digits and underscores (_) are
   allowed.
 * Label name must start with a letter or digit.
 * The maximum length of a label name is 100 characters.
 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.
 

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.
 The label key name must follow:
 * Only upper and lower-case letters, digits and underscores (_) are
   allowed.
 * Label name must start with a letter or digit.
 * The maximum length of a label name is 100 characters.
 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.
 

repeated .google.api.LabelDescriptor labels = 2;

getLabelsOrBuilderList

List<? extends LabelDescriptorOrBuilder> getLabelsOrBuilderList()

 The set of labels that can be used to describe a specific
 instance of this metric type.
 The label key name must follow:
 * Only upper and lower-case letters, digits and underscores (_) are
   allowed.
 * Label name must start with a letter or digit.
 * The maximum length of a label name is 100 characters.
 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.
 

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.
 The label key name must follow:
 * Only upper and lower-case letters, digits and underscores (_) are
   allowed.
 * Label name must start with a letter or digit.
 * The maximum length of a label name is 100 characters.
 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.
 

repeated .google.api.LabelDescriptor labels = 2;

getMetricKindValue

int getMetricKindValue()

 Whether the metric records instantaneous values, changes to a value, etc.
 Some combinations of `metric_kind` and `value_type` might not be supported.
 

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

Returns:

The enum numeric value on the wire for metricKind.

getMetricKind

MetricDescriptor.MetricKind getMetricKind()

 Whether the metric records instantaneous values, changes to a value, etc.
 Some combinations of `metric_kind` and `value_type` might not be supported.
 

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

Returns:

The metricKind.

getValueTypeValue

int getValueTypeValue()

 Whether the measurement is an integer, a floating-point number, etc.
 Some combinations of `metric_kind` and `value_type` might not be supported.
 

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

Returns:

The enum numeric value on the wire for valueType.

getValueType

MetricDescriptor.ValueType getValueType()

 Whether the measurement is an integer, a floating-point number, etc.
 Some combinations of `metric_kind` and `value_type` might not be supported.
 

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

Returns:

The valueType.

getUnit

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`     day
 * `1`     dimensionless
 **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)
 * `Pi`    pebi    (2^50)
 **Grammar**
 The 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").
 

string unit = 5;

Returns:

The unit.

getUnitBytes

com.google.protobuf.ByteString getUnitBytes()

 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`     day
 * `1`     dimensionless
 **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)
 * `Pi`    pebi    (2^50)
 **Grammar**
 The 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").
 

string unit = 5;

Returns:

The bytes for unit.

getDescription

String getDescription()

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

string description = 6;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 6;

Returns:

The bytes for description.

getDisplayName

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.
 

string display_name = 7;

Returns:

The displayName.

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".
 This field is optional but it is recommended to be set for any metrics
 associated with user-visible concepts, such as Quota.
 

string display_name = 7;

Returns:

The bytes for displayName.

hasMetadata

boolean hasMetadata()

 Optional. Metadata which can be used to guide usage of the metric.
 

.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;

Returns:

Whether the metadata field is set.

getMetadata

MetricDescriptor.MetricDescriptorMetadata getMetadata()

 Optional. Metadata which can be used to guide usage of the metric.
 

.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;

Returns:

The metadata.

getMetadataOrBuilder

MetricDescriptor.MetricDescriptorMetadataOrBuilder getMetadataOrBuilder()

 Optional. Metadata which can be used to guide usage of the metric.
 

.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;

getLaunchStageValue

int getLaunchStageValue()

 Optional. The launch stage of the metric definition.
 

.google.api.LaunchStage launch_stage = 12;

Returns:

The enum numeric value on the wire for launchStage.

getLaunchStage

LaunchStage getLaunchStage()

 Optional. The launch stage of the metric definition.
 

.google.api.LaunchStage launch_stage = 12;

Returns:

The launchStage.

getMonitoredResourceTypesList

List<String> getMonitoredResourceTypesList()

 Read-only. If present, then a [time
 series][google.monitoring.v3.TimeSeries], which is identified partially by
 a metric type and a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that is associated
 with this metric type can only be associated with one of the monitored
 resource types listed here.
 

repeated string monitored_resource_types = 13;

Returns:

A list containing the monitoredResourceTypes.

getMonitoredResourceTypesCount

int getMonitoredResourceTypesCount()

 Read-only. If present, then a [time
 series][google.monitoring.v3.TimeSeries], which is identified partially by
 a metric type and a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that is associated
 with this metric type can only be associated with one of the monitored
 resource types listed here.
 

repeated string monitored_resource_types = 13;

Returns:

The count of monitoredResourceTypes.

getMonitoredResourceTypes

String getMonitoredResourceTypes(int index)

 Read-only. If present, then a [time
 series][google.monitoring.v3.TimeSeries], which is identified partially by
 a metric type and a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that is associated
 with this metric type can only be associated with one of the monitored
 resource types listed here.
 

repeated string monitored_resource_types = 13;

Parameters:

index - The index of the element to return.

Returns:

The monitoredResourceTypes at the given index.

getMonitoredResourceTypesBytes

com.google.protobuf.ByteString getMonitoredResourceTypesBytes(int index)

 Read-only. If present, then a [time
 series][google.monitoring.v3.TimeSeries], which is identified partially by
 a metric type and a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that is associated
 with this metric type can only be associated with one of the monitored
 resource types listed here.
 

repeated string monitored_resource_types = 13;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the monitoredResourceTypes at the given index.