MetricDescriptor class

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.


MetricDescriptor.fromJson(Map _json)


description String
A detailed description of the metric, which can be used in documentation.
read / write
displayName String
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.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
labels List<LabelDescriptor>
The set of labels that can be used to describe a specific instance of this metric type. For example, the 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.
read / write
launchStage String
Optional. The launch stage of the metric definition. Possible string values are: [...]
read / write
metadata MetricDescriptorMetadata
Optional. Metadata which can be used to guide usage of the metric.
read / write
metricKind String
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. Possible string values are: [...]
read / write
monitoredResourceTypes List<String>
Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
read / write
name String
The resource name of the metric descriptor.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
type String
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name or Metric types should use a natural hierarchical grouping. For example: [...]
read / write
unit String
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. [...]
read / write
valueType String
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. Possible string values are: [...]
read / write


noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toJson() Map<String, Object>
toString() String
Returns a string representation of this object.


operator ==(Object other) bool
The equality operator. [...]