public final class TimeSeries extends GeneratedMessageV3 implements TimeSeriesOrBuilder
A collection of data points that describes the time-varying values
of a metric. A time series is identified by a combination of a
fully-specified monitored resource and a fully-specified metric.
This type is used for both listing and creating time series.
Protobuf type google.monitoring.v3.TimeSeries
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
public static final int METADATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_FIELD_NUMBER
public static final int METRIC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_KIND_FIELD_NUMBER
public static final int METRIC_KIND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
POINTS_FIELD_NUMBER
public static final int POINTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESOURCE_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UNIT_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VALUE_TYPE_FIELD_NUMBER
public static final int VALUE_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static TimeSeries getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TimeSeries.Builder newBuilder()
newBuilder(TimeSeries prototype)
public static TimeSeries.Builder newBuilder(TimeSeries prototype)
public static TimeSeries parseDelimitedFrom(InputStream input)
public static TimeSeries parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TimeSeries parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TimeSeries parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TimeSeries parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TimeSeries parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TimeSeries parseFrom(CodedInputStream input)
public static TimeSeries parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TimeSeries parseFrom(InputStream input)
public static TimeSeries parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TimeSeries parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TimeSeries parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TimeSeries> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public TimeSeries getDefaultInstanceForType()
public 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.
|
public 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 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 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 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 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 | |
getParserForType()
public Parser<TimeSeries> getParserForType()
Overrides
getPoints(int index)
public 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 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 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;
getPointsOrBuilder(int index)
public 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
|
getPointsOrBuilderList()
public 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 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 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 | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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 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 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 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.
|
public 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TimeSeries.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TimeSeries.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public TimeSeries.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
