com.google.api.services.dataflow.model

Class MetricUpdate

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataflow.model.MetricUpdate

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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 Google 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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MetricUpdate()

Method Summary

Methods

Modifier and Type	Method and Description
MetricUpdate	clone()
java.lang.Boolean	getCumulative() True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
java.lang.Object	getDistribution() A struct value describing properties of a distribution of numeric values.
java.lang.Object	getInternal() Worker-computed aggregate value for internal use by the Dataflow service.
java.lang.String	getKind() Metric aggregation kind.
java.lang.Object	getMeanCount() Worker-computed aggregate value for the "Mean" aggregation kind.
java.lang.Object	getMeanSum() Worker-computed aggregate value for the "Mean" aggregation kind.
MetricStructuredName	getName() Name of the metric.
java.lang.Object	getScalar() Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
java.lang.Object	getSet() Worker-computed aggregate value for the "Set" aggregation kind.
java.lang.String	getUpdateTime() Timestamp associated with the metric value.
MetricUpdate	set(java.lang.String fieldName, java.lang.Object value)
MetricUpdate	setCumulative(java.lang.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(java.lang.Object distribution) A struct value describing properties of a distribution of numeric values.
MetricUpdate	setInternal(java.lang.Object internal) Worker-computed aggregate value for internal use by the Dataflow service.
MetricUpdate	setKind(java.lang.String kind) Metric aggregation kind.
MetricUpdate	setMeanCount(java.lang.Object meanCount) Worker-computed aggregate value for the "Mean" aggregation kind.
MetricUpdate	setMeanSum(java.lang.Object meanSum) Worker-computed aggregate value for the "Mean" aggregation kind.
MetricUpdate	setName(MetricStructuredName name) Name of the metric.
MetricUpdate	setScalar(java.lang.Object scalar) Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
MetricUpdate	setSet(java.lang.Object set) Worker-computed aggregate value for the "Set" aggregation kind.
MetricUpdate	setUpdateTime(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricUpdate

public MetricUpdate()

Method Detail

getCumulative

public java.lang.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(java.lang.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 java.lang.Object getDistribution()

A struct value describing properties of a distribution of numeric values.

Returns:

value or null for none

setDistribution

public MetricUpdate setDistribution(java.lang.Object distribution)

A struct value describing properties of a distribution of numeric values.

Parameters:

distribution - distribution or null for none

getInternal

public java.lang.Object getInternal()

Worker-computed aggregate value for internal use by the Dataflow service.

Returns:

value or null for none

setInternal

public MetricUpdate setInternal(java.lang.Object internal)

Worker-computed aggregate value for internal use by the Dataflow service.

Parameters:

internal - internal or null for none

getKind

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.String fieldName,
               java.lang.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