com.google.monitoring.v3

Interface TimeSeriesOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TimeSeries, TimeSeries.Builder

public interface TimeSeriesOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.api.MonitoredResourceMetadata	getMetadata() Output only.
com.google.api.MonitoredResourceMetadataOrBuilder	getMetadataOrBuilder() Output only.
com.google.api.Metric	getMetric() The associated metric.
com.google.api.MetricDescriptor.MetricKind	getMetricKind() The metric kind of the time series.
int	getMetricKindValue() The metric kind of the time series.
com.google.api.MetricOrBuilder	getMetricOrBuilder() The associated metric.
Point	getPoints(int index) The data points of this time series.
int	getPointsCount() The data points of this time series.
List<Point>	getPointsList() The data points of this time series.
PointOrBuilder	getPointsOrBuilder(int index) The data points of this time series.
List<? extends PointOrBuilder>	getPointsOrBuilderList() The data points of this time series.
com.google.api.MonitoredResource	getResource() The associated monitored resource.
com.google.api.MonitoredResourceOrBuilder	getResourceOrBuilder() The associated monitored resource.
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.
com.google.api.MetricDescriptor.ValueType	getValueType() The value type of the time series.
int	getValueTypeValue() The value type of the time series.
boolean	hasMetadata() Output only.
boolean	hasMetric() The associated metric.
boolean	hasResource() The associated monitored resource.

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

hasMetric

boolean hasMetric()

 The associated metric. A fully-specified metric used to identify the time
 series.
 

.google.api.Metric metric = 1;

Returns:

Whether the metric field is set.

getMetric

com.google.api.Metric getMetric()

 The associated metric. A fully-specified metric used to identify the time
 series.
 

.google.api.Metric metric = 1;

Returns:

The metric.

getMetricOrBuilder

com.google.api.MetricOrBuilder getMetricOrBuilder()

 The associated metric. A fully-specified metric used to identify the time
 series.
 

.google.api.Metric metric = 1;

hasResource

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](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
 

.google.api.MonitoredResource resource = 2;

Returns:

Whether the resource field is set.

getResource

com.google.api.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](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
 

.google.api.MonitoredResource resource = 2;

Returns:

The resource.

getResourceOrBuilder

com.google.api.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](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
 

.google.api.MonitoredResource resource = 2;

hasMetadata

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:

Whether the metadata field is set.

getMetadata

com.google.api.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:

The metadata.

getMetadataOrBuilder

com.google.api.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;

getMetricKindValue

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:

The enum numeric value on the wire for metricKind.

getMetricKind

com.google.api.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:

The metricKind.

getValueTypeValue

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:

The enum numeric value on the wire for valueType.

getValueType

com.google.api.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:

The valueType.

getPointsList

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;

getPoints

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;

getPointsCount

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;

getPointsOrBuilderList

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;

getPointsOrBuilder

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;

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.
 

string unit = 8;

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.
 

string unit = 8;

Returns:

The bytes for unit.