GoogleMonitoringV3TimeSeries (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleMonitoringV3TimeSeries

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleMonitoringV3TimeSeries
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleMonitoringV3TimeSeries()

Constructors
Constructor and Description
`GoogleMonitoringV3TimeSeries()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleMonitoringV3TimeSeries`	`clone()`
`String`	`getDescription()` Input only.
`GoogleApiMonitoredResourceMetadata`	`getMetadata()` Output only.
`GoogleApiMetric`	`getMetric()` The associated metric.
`String`	`getMetricKind()` The metric kind of the time series.
`List<GoogleMonitoringV3Point>`	`getPoints()` The data points of this time series.
`GoogleApiMonitoredResource`	`getResource()` The associated monitored resource.
`String`	`getUnit()` The units in which the metric value is reported.
`String`	`getValueType()` The value type of the time series.
`GoogleMonitoringV3TimeSeries`	`set(String fieldName, Object value)`
`GoogleMonitoringV3TimeSeries`	`setDescription(String description)` Input only.
`GoogleMonitoringV3TimeSeries`	`setMetadata(GoogleApiMonitoredResourceMetadata metadata)` Output only.
`GoogleMonitoringV3TimeSeries`	`setMetric(GoogleApiMetric metric)` The associated metric.
`GoogleMonitoringV3TimeSeries`	`setMetricKind(String metricKind)` The metric kind of the time series.
`GoogleMonitoringV3TimeSeries`	`setPoints(List<GoogleMonitoringV3Point> points)` The data points of this time series.
`GoogleMonitoringV3TimeSeries`	`setResource(GoogleApiMonitoredResource resource)` The associated monitored resource.
`GoogleMonitoringV3TimeSeries`	`setUnit(String unit)` The units in which the metric value is reported.
`GoogleMonitoringV3TimeSeries`	`setValueType(String valueType)` The value type of the time series.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleMonitoringV3TimeSeries
```
public GoogleMonitoringV3TimeSeries()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleMonitoringV3TimeSeries setDescription(String description)
```
    Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.
    
    Parameters:
    
    description - description or null for none
  - getMetadata
```
public GoogleApiMonitoredResourceMetadata 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.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public GoogleMonitoringV3TimeSeries setMetadata(GoogleApiMonitoredResourceMetadata metadata)
```
    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.
    
    Parameters:
    
    metadata - metadata or null for none
  - getMetric
```
public GoogleApiMetric getMetric()
```
    The associated metric. A fully-specified metric used to identify the time series.
    
    Returns:
    
    value or null for none
  - setMetric
```
public GoogleMonitoringV3TimeSeries setMetric(GoogleApiMetric metric)
```
    The associated metric. A fully-specified metric used to identify the time series.
    
    Parameters:
    
    metric - metric or null for none
  - getMetricKind
```
public String 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`.
    
    Returns:
    
    value or null for none
  - setMetricKind
```
public GoogleMonitoringV3TimeSeries setMetricKind(String metricKind)
```
    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`.
    
    Parameters:
    
    metricKind - metricKind or null for none
  - getPoints
```
public List<GoogleMonitoringV3Point> getPoints()
```
    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`.
    
    Returns:
    
    value or null for none
  - setPoints
```
public GoogleMonitoringV3TimeSeries setPoints(List<GoogleMonitoringV3Point> points)
```
    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`.
    
    Parameters:
    
    points - points or null for none
  - getResource
```
public GoogleApiMonitoredResource 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).
    
    Returns:
    
    value or null for none
  - setResource
```
public GoogleMonitoringV3TimeSeries setResource(GoogleApiMonitoredResource resource)
```
    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).
    
    Parameters:
    
    resource - resource or null for none
  - 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. This field can only be changed through CreateTimeSeries when it is empty.
    
    Returns:
    
    value or null for none
  - setUnit
```
public GoogleMonitoringV3TimeSeries setUnit(String unit)
```
    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. This field can only be changed through CreateTimeSeries when it is empty.
    
    Parameters:
    
    unit - unit or null for none
  - getValueType
```
public String 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.
    
    Returns:
    
    value or null for none
  - setValueType
```
public GoogleMonitoringV3TimeSeries setValueType(String valueType)
```
    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.
    
    Parameters:
    
    valueType - valueType or null for none
  - set
```
public GoogleMonitoringV3TimeSeries set(String fieldName,
                                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleMonitoringV3TimeSeries clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleMonitoringV3TimeSeries

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleMonitoringV3TimeSeries

Method Detail

getDescription

setDescription

getMetadata

setMetadata

getMetric

setMetric

getMetricKind

setMetricKind

getPoints

setPoints

getResource

setResource

getUnit

setUnit

getValueType

setValueType

set

clone