MetricUpdate (Dataflow API v1b3-rev20240817-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.dataflow.model.MetricUpdate

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class MetricUpdate
extends com.google.api.client.json.GenericJson
```
Describes the state of a metric.
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 Dataflow 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

MetricUpdate()

Constructors
Constructor and Description
`MetricUpdate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricUpdate`	`clone()`
`Boolean`	`getCumulative()` True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
`Object`	`getDistribution()` A struct value describing properties of a distribution of numeric values.
`Object`	`getGauge()` A struct value describing properties of a Gauge.
`Object`	`getInternal()` Worker-computed aggregate value for internal use by the Dataflow service.
`String`	`getKind()` Metric aggregation kind.
`Object`	`getMeanCount()` Worker-computed aggregate value for the "Mean" aggregation kind.
`Object`	`getMeanSum()` Worker-computed aggregate value for the "Mean" aggregation kind.
`MetricStructuredName`	`getName()` Name of the metric.
`Object`	`getScalar()` Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
`Object`	`getSet()` Worker-computed aggregate value for the "Set" aggregation kind.
`String`	`getUpdateTime()` Timestamp associated with the metric value.
`MetricUpdate`	`set(String fieldName, Object value)`
`MetricUpdate`	`setCumulative(Boolean cumulative)` True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
`MetricUpdate`	`setDistribution(Object distribution)` A struct value describing properties of a distribution of numeric values.
`MetricUpdate`	`setGauge(Object gauge)` A struct value describing properties of a Gauge.
`MetricUpdate`	`setInternal(Object internal)` Worker-computed aggregate value for internal use by the Dataflow service.
`MetricUpdate`	`setKind(String kind)` Metric aggregation kind.
`MetricUpdate`	`setMeanCount(Object meanCount)` Worker-computed aggregate value for the "Mean" aggregation kind.
`MetricUpdate`	`setMeanSum(Object meanSum)` Worker-computed aggregate value for the "Mean" aggregation kind.
`MetricUpdate`	`setName(MetricStructuredName name)` Name of the metric.
`MetricUpdate`	`setScalar(Object scalar)` Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
`MetricUpdate`	`setSet(Object set)` Worker-computed aggregate value for the "Set" aggregation kind.
`MetricUpdate`	`setUpdateTime(String updateTime)` Timestamp associated with the metric value.

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
  - MetricUpdate
```
public MetricUpdate()
```
- Method Detail
  - getCumulative
```
public Boolean getCumulative()
```
    True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
    
    Returns:
    
    value or null for none
  - setCumulative
```
public MetricUpdate setCumulative(Boolean cumulative)
```
    True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
    
    Parameters:
    
    cumulative - cumulative or null for none
  - getDistribution
```
public Object getDistribution()
```
    A struct value describing properties of a distribution of numeric values.
    
    Returns:
    
    value or null for none
  - setDistribution
```
public MetricUpdate setDistribution(Object distribution)
```
    A struct value describing properties of a distribution of numeric values.
    
    Parameters:
    
    distribution - distribution or null for none
  - getGauge
```
public Object getGauge()
```
    A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
    
    Returns:
    
    value or null for none
  - setGauge
```
public MetricUpdate setGauge(Object gauge)
```
    A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
    
    Parameters:
    
    gauge - gauge or null for none
  - getInternal
```
public Object getInternal()
```
    Worker-computed aggregate value for internal use by the Dataflow service.
    
    Returns:
    
    value or null for none
  - setInternal
```
public MetricUpdate setInternal(Object internal)
```
    Worker-computed aggregate value for internal use by the Dataflow service.
    
    Parameters:
    
    internal - internal or null for none
  - getKind
```
public String getKind()
```
    Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
    
    Returns:
    
    value or null for none
  - setKind
```
public MetricUpdate setKind(String kind)
```
    Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
    
    Parameters:
    
    kind - kind or null for none
  - getMeanCount
```
public Object getMeanCount()
```
    Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
    
    Returns:
    
    value or null for none
  - setMeanCount
```
public MetricUpdate setMeanCount(Object meanCount)
```
    Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
    
    Parameters:
    
    meanCount - meanCount or null for none
  - getMeanSum
```
public Object getMeanSum()
```
    Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
    
    Returns:
    
    value or null for none
  - setMeanSum
```
public MetricUpdate setMeanSum(Object meanSum)
```
    Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
    
    Parameters:
    
    meanSum - meanSum or null for none
  - getName
```
public MetricStructuredName getName()
```
    Name of the metric.
    
    Returns:
    
    value or null for none
  - setName
```
public MetricUpdate setName(MetricStructuredName name)
```
    Name of the metric.
    
    Parameters:
    
    name - name or null for none
  - getScalar
```
public Object getScalar()
```
    Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
    
    Returns:
    
    value or null for none
  - setScalar
```
public MetricUpdate setScalar(Object scalar)
```
    Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
    
    Parameters:
    
    scalar - scalar or null for none
  - getSet
```
public Object getSet()
```
    Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
    
    Returns:
    
    value or null for none
  - setSet
```
public MetricUpdate setSet(Object set)
```
    Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
    
    Parameters:
    
    set - set or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public MetricUpdate setUpdateTime(String updateTime)
```
    Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public MetricUpdate set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public MetricUpdate clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class MetricUpdate

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

MetricUpdate

Method Detail

getCumulative

setCumulative

getDistribution

setDistribution

getGauge

setGauge

getInternal

setInternal

getKind

setKind

getMeanCount

setMeanCount

getMeanSum

setMeanSum

getName

setName

getScalar

setScalar

getSet

setSet

getUpdateTime

setUpdateTime

set

clone