com.google.api

Interface MetricDescriptorOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

MetricDescriptor, MetricDescriptor.Builder

public interface MetricDescriptorOrBuilder
extends 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.
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.
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.
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.
java.lang.String	getName() The resource name of the metric descriptor.
ByteString	getNameBytes() The resource name of the metric descriptor.
java.lang.String	getType() The metric type, including its DNS name prefix.
ByteString	getTypeBytes() The metric type, including its DNS name prefix.
java.lang.String	getUnit() The unit in which the metric value is reported.
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.
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

java.lang.String getName()

 The resource name of the metric descriptor.
 

string name = 1;

getNameBytes

ByteString getNameBytes()

 The resource name of the metric descriptor.
 

string name = 1;

getType

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"
 

string type = 8;

getTypeBytes

ByteString getTypeBytes()

 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"
 

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

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
 `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. 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;

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;

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;

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;

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

string unit = 5;

getUnitBytes

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

string unit = 5;

getDescription

java.lang.String getDescription()

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

string description = 6;

getDescriptionBytes

ByteString getDescriptionBytes()

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

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

getDisplayNameBytes

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;

hasMetadata

boolean hasMetadata()

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

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

getMetadata

MetricDescriptor.MetricDescriptorMetadata getMetadata()

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

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

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;

getLaunchStage

LaunchStage getLaunchStage()

 Optional. The launch stage of the metric definition.
 

.google.api.LaunchStage launch_stage = 12;