- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public interface TimeSeriesOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getMetadata()
public abstract MonitoredResourceMetadata getMetadata()Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
.google.api.MonitoredResourceMetadata metadata = 7;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResourceMetadata |
The metadata. |
getMetadataOrBuilder()
public abstract MonitoredResourceMetadataOrBuilder getMetadataOrBuilder()Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
.google.api.MonitoredResourceMetadata metadata = 7;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResourceMetadataOrBuilder |
|
getMetric()
public abstract Metric getMetric()The associated metric. A fully-specified metric used to identify the time series.
.google.api.Metric metric = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.api.Metric |
The metric. |
getMetricKind()
public abstract MetricDescriptor.MetricKind getMetricKind()The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.
When creating a time series, this field is optional. If present, it must be
the same as the metric kind of the associated metric. If the associated
metric's descriptor must be auto-created, then this field specifies the
metric kind of the new descriptor and must be either GAUGE (the default)
or CUMULATIVE.
.google.api.MetricDescriptor.MetricKind metric_kind = 3;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MetricDescriptor.MetricKind |
The metricKind. |
getMetricKindValue()
public abstract int getMetricKindValue()The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.
When creating a time series, this field is optional. If present, it must be
the same as the metric kind of the associated metric. If the associated
metric's descriptor must be auto-created, then this field specifies the
metric kind of the new descriptor and must be either GAUGE (the default)
or CUMULATIVE.
.google.api.MetricDescriptor.MetricKind metric_kind = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for metricKind. |
getMetricOrBuilder()
public abstract MetricOrBuilder getMetricOrBuilder()The associated metric. A fully-specified metric used to identify the time series.
.google.api.Metric metric = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MetricOrBuilder |
|
getPoints(int index)
public abstract Point getPoints(int index)The data points of this time series. When listing time series, points are returned in reverse time order.
When creating a time series, this field must contain exactly one point and
the point's type must be the same as the value type of the associated
metric. If the associated metric's descriptor must be auto-created, then
the value type of the descriptor is determined by the point's type, which
must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
repeated .google.monitoring.v3.Point points = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Point |
|
getPointsCount()
public abstract int getPointsCount()The data points of this time series. When listing time series, points are returned in reverse time order.
When creating a time series, this field must contain exactly one point and
the point's type must be the same as the value type of the associated
metric. If the associated metric's descriptor must be auto-created, then
the value type of the descriptor is determined by the point's type, which
must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
repeated .google.monitoring.v3.Point points = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getPointsList()
public abstract List<Point> getPointsList()The data points of this time series. When listing time series, points are returned in reverse time order.
When creating a time series, this field must contain exactly one point and
the point's type must be the same as the value type of the associated
metric. If the associated metric's descriptor must be auto-created, then
the value type of the descriptor is determined by the point's type, which
must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
repeated .google.monitoring.v3.Point points = 5;
| Returns | |
|---|---|
| Type | Description |
List<Point> |
|
getPointsOrBuilder(int index)
public abstract PointOrBuilder getPointsOrBuilder(int index)The data points of this time series. When listing time series, points are returned in reverse time order.
When creating a time series, this field must contain exactly one point and
the point's type must be the same as the value type of the associated
metric. If the associated metric's descriptor must be auto-created, then
the value type of the descriptor is determined by the point's type, which
must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
repeated .google.monitoring.v3.Point points = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PointOrBuilder |
|
getPointsOrBuilderList()
public abstract List<? extends PointOrBuilder> getPointsOrBuilderList()The data points of this time series. When listing time series, points are returned in reverse time order.
When creating a time series, this field must contain exactly one point and
the point's type must be the same as the value type of the associated
metric. If the associated metric's descriptor must be auto-created, then
the value type of the descriptor is determined by the point's type, which
must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
repeated .google.monitoring.v3.Point points = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.monitoring.v3.PointOrBuilder> |
|
getResource()
public abstract MonitoredResource getResource()The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics.
.google.api.MonitoredResource resource = 2;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResource |
The resource. |
getResourceOrBuilder()
public abstract MonitoredResourceOrBuilder getResourceOrBuilder()The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics.
.google.api.MonitoredResource resource = 2;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResourceOrBuilder |
|
getUnit()
public abstract 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.
string unit = 8;
| Returns | |
|---|---|
| Type | Description |
String |
The unit. |
getUnitBytes()
public abstract 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.
string unit = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for unit. |
getValueType()
public abstract MetricDescriptor.ValueType getValueType()The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.
When creating a time series, this field is optional. If present, it must be
the same as the type of the data in the points field.
.google.api.MetricDescriptor.ValueType value_type = 4;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MetricDescriptor.ValueType |
The valueType. |
getValueTypeValue()
public abstract int getValueTypeValue()The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.
When creating a time series, this field is optional. If present, it must be
the same as the type of the data in the points field.
.google.api.MetricDescriptor.ValueType value_type = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for valueType. |
hasMetadata()
public abstract boolean hasMetadata()Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
.google.api.MonitoredResourceMetadata metadata = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the metadata field is set. |
hasMetric()
public abstract boolean hasMetric()The associated metric. A fully-specified metric used to identify the time series.
.google.api.Metric metric = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the metric field is set. |
hasResource()
public abstract boolean hasResource()The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics.
.google.api.MonitoredResource resource = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the resource field is set. |