lightstep.com.google.api.MetricDescriptorOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/metric.proto
package lightstep.lightstep.lightstep.com.google.api;
public interface MetricDescriptorOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.api.MetricDescriptor)
lightstep.com.lightstep.lightstep.lightstep.google.protobuf.MessageOrBuilder {
/**
*
* The resource name of the metric descriptor.
*
*
* string name = 1;
*/
String getName();
/**
*
* The resource name of the metric descriptor.
*
*
* string name = 1;
*/
lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
getNameBytes();
/**
*
* 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;
*/
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;
*/
lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
getTypeBytes();
/**
*
* 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;
*/
java.util.List
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;
*/
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;
*/
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;
*/
java.util.List
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;
*/
LabelDescriptorOrBuilder getLabelsOrBuilder(
int index);
/**
*
* 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;
*/
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;
*/
MetricDescriptor.MetricKind getMetricKind();
/**
*
* 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;
*/
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;
*/
MetricDescriptor.ValueType getValueType();
/**
*
* 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;
*/
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;
*/
lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
getUnitBytes();
/**
*
* A detailed description of the metric, which can be used in documentation.
*
*
* string description = 6;
*/
String getDescription();
/**
*
* A detailed description of the metric, which can be used in documentation.
*
*
* string description = 6;
*/
lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* 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;
*/
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;
*/
lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
getDisplayNameBytes();
/**
*
* Optional. Metadata which can be used to guide usage of the metric.
*
*
* .google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;
*/
boolean hasMetadata();
/**
*
* Optional. Metadata which can be used to guide usage of the metric.
*
*
* .google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;
*/
MetricDescriptor.MetricDescriptorMetadata getMetadata();
/**
*
* Optional. Metadata which can be used to guide usage of the metric.
*
*
* .google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;
*/
MetricDescriptor.MetricDescriptorMetadataOrBuilder getMetadataOrBuilder();
/**
*
* Optional. The launch stage of the metric definition.
*
*
* .google.api.LaunchStage launch_stage = 12;
*/
int getLaunchStageValue();
/**
*
* Optional. The launch stage of the metric definition.
*
*
* .google.api.LaunchStage launch_stage = 12;
*/
LaunchStage getLaunchStage();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy