public final class TimeSeries extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
TimeSeries.Builder
A collection of data points that describes the time-varying values
of a metric.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
METADATA_FIELD_NUMBER |
static int |
METRIC_FIELD_NUMBER |
static int |
METRIC_KIND_FIELD_NUMBER |
static int |
POINTS_FIELD_NUMBER |
static int |
RESOURCE_FIELD_NUMBER |
static int |
UNIT_FIELD_NUMBER |
static int |
VALUE_TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static TimeSeries |
getDefaultInstance() |
TimeSeries |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<TimeSeries> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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.
|
int |
hashCode() |
boolean |
hasMetadata()
Output only.
|
boolean |
hasMetric()
The associated metric.
|
boolean |
hasResource()
The associated monitored resource.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static TimeSeries.Builder |
newBuilder() |
static TimeSeries.Builder |
newBuilder(TimeSeries prototype) |
TimeSeries.Builder |
newBuilderForType() |
protected TimeSeries.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static TimeSeries |
parseDelimitedFrom(InputStream input) |
static TimeSeries |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TimeSeries |
parseFrom(byte[] data) |
static TimeSeries |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TimeSeries |
parseFrom(ByteBuffer data) |
static TimeSeries |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TimeSeries |
parseFrom(com.google.protobuf.ByteString data) |
static TimeSeries |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TimeSeries |
parseFrom(com.google.protobuf.CodedInputStream input) |
static TimeSeries |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TimeSeries |
parseFrom(InputStream input) |
static TimeSeries |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<TimeSeries> |
parser() |
TimeSeries.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int METRIC_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int METRIC_KIND_FIELD_NUMBER
public static final int VALUE_TYPE_FIELD_NUMBER
public static final int POINTS_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasMetric()
The associated metric. A fully-specified metric used to identify the time series.
.google.api.Metric metric = 1;hasMetric in interface TimeSeriesOrBuilderpublic com.google.api.Metric getMetric()
The associated metric. A fully-specified metric used to identify the time series.
.google.api.Metric metric = 1;getMetric in interface TimeSeriesOrBuilderpublic com.google.api.MetricOrBuilder getMetricOrBuilder()
The associated metric. A fully-specified metric used to identify the time series.
.google.api.Metric metric = 1;getMetricOrBuilder in interface TimeSeriesOrBuilderpublic 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;hasResource in interface TimeSeriesOrBuilderpublic 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;getResource in interface TimeSeriesOrBuilderpublic 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;getResourceOrBuilder in interface TimeSeriesOrBuilderpublic 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;hasMetadata in interface TimeSeriesOrBuilderpublic 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;getMetadata in interface TimeSeriesOrBuilderpublic 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;getMetadataOrBuilder in interface TimeSeriesOrBuilderpublic 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;getMetricKindValue in interface TimeSeriesOrBuilderpublic 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;getMetricKind in interface TimeSeriesOrBuilderpublic 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;getValueTypeValue in interface TimeSeriesOrBuilderpublic 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;getValueType in interface TimeSeriesOrBuilderpublic 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;getPointsList in interface TimeSeriesOrBuilderpublic 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;getPointsOrBuilderList in interface TimeSeriesOrBuilderpublic 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;getPointsCount in interface TimeSeriesOrBuilderpublic 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;getPoints in interface TimeSeriesOrBuilderpublic 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;getPointsOrBuilder in interface TimeSeriesOrBuilderpublic 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;getUnit in interface TimeSeriesOrBuilderpublic 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;getUnitBytes in interface TimeSeriesOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static TimeSeries parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TimeSeries parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TimeSeries parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TimeSeries parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TimeSeries parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TimeSeries parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TimeSeries parseFrom(InputStream input) throws IOException
IOExceptionpublic static TimeSeries parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TimeSeries parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static TimeSeries parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TimeSeries parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static TimeSeries parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic TimeSeries.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static TimeSeries.Builder newBuilder()
public static TimeSeries.Builder newBuilder(TimeSeries prototype)
public TimeSeries.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected TimeSeries.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static TimeSeries getDefaultInstance()
public static com.google.protobuf.Parser<TimeSeries> parser()
public com.google.protobuf.Parser<TimeSeries> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public TimeSeries getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.