target.apidocs.com.google.api.services.dataflow.model.JobMetrics.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dataflow Show documentation

There is a newer version: v1b4-rev7-1.20.0

Show newest version







JobMetrics (Dataflow API v1b3-rev20231112-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataflow.model
Class JobMetrics



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.JobMetrics













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class JobMetrics
extends com.google.api.client.json.GenericJson
JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job.
 Metrics correspond to user-defined and system-defined metrics in the job. For more information,
 see [Dataflow job metrics] (https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf).
 This resource captures only the most recent values of each metric; time-series data can be
 queried for them (under the same metric names) from Cloud Monitoring.

  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


JobMetrics() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


JobMetrics
clone() 


List<MetricUpdate>
getMetrics()
All metrics for this job.



String
getMetricTime()
Timestamp as of which metric values are current.



JobMetrics
set(String fieldName,
   Object value) 


JobMetrics
setMetrics(List<MetricUpdate> metrics)
All metrics for this job.



JobMetrics
setMetricTime(String metricTime)
Timestamp as of which metric values are current.







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





JobMetrics
public JobMetrics()









Method Detail





getMetricTime
public String getMetricTime()
Timestamp as of which metric values are current.

Returns:
value or null for none








setMetricTime
public JobMetrics setMetricTime(String metricTime)
Timestamp as of which metric values are current.

Parameters:
metricTime - metricTime or null for none








getMetrics
public List<MetricUpdate> getMetrics()
All metrics for this job.

Returns:
value or null for none








setMetrics
public JobMetrics setMetrics(List<MetricUpdate> metrics)
All metrics for this job.

Parameters:
metrics - metrics or null for none








set
public JobMetrics set(String fieldName,
                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public JobMetrics clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.

Modifier and Type	Method and Description
`JobMetrics`	`clone()`
`List<MetricUpdate>`	`getMetrics()` All metrics for this job.
`String`	`getMetricTime()` Timestamp as of which metric values are current.
`JobMetrics`	`set(String fieldName, Object value)`
`JobMetrics`	`setMetrics(List<MetricUpdate> metrics)` All metrics for this job.
`JobMetrics`	`setMetricTime(String metricTime)` Timestamp as of which metric values are current.