Package com.google.monitoring.v3

Class TimeSeries

  • All Implemented Interfaces:
    TimeSeriesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TimeSeries.Builder
      A collection of data points that describes the time-varying values of a metric.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasMetric

        public boolean hasMetric()
         The associated metric. A fully-specified metric used to identify the time
 series.
        .google.api.Metric metric = 1;
        Specified by:
        hasMetric in interface TimeSeriesOrBuilder
        Returns:
        Whether the metric field is set.

      • getMetric

        public com.google.api.Metric getMetric()
         The associated metric. A fully-specified metric used to identify the time
 series.
        .google.api.Metric metric = 1;
        Specified by:
        getMetric in interface TimeSeriesOrBuilder
        Returns:
        The metric.

      • getMetricOrBuilder

        public com.google.api.MetricOrBuilder getMetricOrBuilder()
         The associated metric. A fully-specified metric used to identify the time
 series.
        .google.api.Metric metric = 1;
        Specified by:
        getMetricOrBuilder in interface TimeSeriesOrBuilder

      • 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](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
        .google.api.MonitoredResource resource = 2;
        Specified by:
        hasResource in interface TimeSeriesOrBuilder
        Returns:
        Whether the resource field is set.

      • getResource

        public 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;
        Specified by:
        getResource in interface TimeSeriesOrBuilder
        Returns:
        The resource.

      • getResourceOrBuilder

        public 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;
        Specified by:
        getResourceOrBuilder in interface TimeSeriesOrBuilder

      • hasMetadata

        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;
        Specified by:
        hasMetadata in interface TimeSeriesOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public 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;
        Specified by:
        getMetadata in interface TimeSeriesOrBuilder
        Returns:
        The metadata.

      • getMetadataOrBuilder

        public 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;
        Specified by:
        getMetadataOrBuilder in interface TimeSeriesOrBuilder

      • 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;
        Specified by:
        getMetricKindValue in interface TimeSeriesOrBuilder
        Returns:
        The enum numeric value on the wire for metricKind.

      • getMetricKind

        public 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;
        Specified by:
        getMetricKind in interface TimeSeriesOrBuilder
        Returns:
        The metricKind.

      • 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;
        Specified by:
        getValueTypeValue in interface TimeSeriesOrBuilder
        Returns:
        The enum numeric value on the wire for valueType.

      • getValueType

        public 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;
        Specified by:
        getValueType in interface TimeSeriesOrBuilder
        Returns:
        The valueType.

      • 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;
        Specified by:
        getPointsList in interface TimeSeriesOrBuilder

      • 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;
        Specified by:
        getPointsOrBuilderList in interface TimeSeriesOrBuilder

      • 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;
        Specified by:
        getPointsCount in interface TimeSeriesOrBuilder

      • getPoints

        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;
        Specified by:
        getPoints in interface TimeSeriesOrBuilder

      • getPointsOrBuilder

        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;
        Specified by:
        getPointsOrBuilder in interface TimeSeriesOrBuilder

      • getUnit

        public 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;
        Specified by:
        getUnit in interface TimeSeriesOrBuilder
        Returns:
        The unit.

      • getUnitBytes

        public 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;
        Specified by:
        getUnitBytes in interface TimeSeriesOrBuilder
        Returns:
        The bytes for unit.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TimeSeries parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TimeSeries parseFrom​(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TimeSeries parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TimeSeries parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TimeSeries parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TimeSeries parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TimeSeries parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TimeSeries.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TimeSeries.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TimeSeries.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static TimeSeries getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<TimeSeries> parser()

      • getParserForType

        public com.google.protobuf.Parser<TimeSeries> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TimeSeries getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder