target.apidocs.com.google.api.services.dataflow.model.MetricStructuredName.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







MetricStructuredName (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 MetricStructuredName



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













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




public final class MetricStructuredName
extends com.google.api.client.json.GenericJson
Identifies a metric, by describing the source which generated the 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


MetricStructuredName() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


MetricStructuredName
clone() 


Map<String,String>
getContext()
Zero or more labeled fields which identify the part of the job this metric is associated with,
 such as the name of a step or collection.



String
getName()
Worker-defined metric name.



String
getOrigin()
Origin (namespace) of metric name.



MetricStructuredName
set(String fieldName,
   Object value) 


MetricStructuredName
setContext(Map<String,String> context)
Zero or more labeled fields which identify the part of the job this metric is associated with,
 such as the name of a step or collection.



MetricStructuredName
setName(String name)
Worker-defined metric name.



MetricStructuredName
setOrigin(String origin)
Origin (namespace) of metric name.







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





MetricStructuredName
public MetricStructuredName()









Method Detail





getContext
public Map<String,String> getContext()
Zero or more labeled fields which identify the part of the job this metric is associated with,
 such as the name of a step or collection. For example, built-in counters associated with steps
 will have context['step'] = . Counters associated with PCollections in the SDK will have
 context['pcollection'] = .

Returns:
value or null for none








setContext
public MetricStructuredName setContext(Map<String,String> context)
Zero or more labeled fields which identify the part of the job this metric is associated with,
 such as the name of a step or collection. For example, built-in counters associated with steps
 will have context['step'] = . Counters associated with PCollections in the SDK will have
 context['pcollection'] = .

Parameters:
context - context or null for none








getName
public String getName()
Worker-defined metric name.

Returns:
value or null for none








setName
public MetricStructuredName setName(String name)
Worker-defined metric name.

Parameters:
name - name or null for none








getOrigin
public String getOrigin()
Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for
 metrics defined by the Dataflow service or SDK.

Returns:
value or null for none








setOrigin
public MetricStructuredName setOrigin(String origin)
Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for
 metrics defined by the Dataflow service or SDK.

Parameters:
origin - origin or null for none








set
public MetricStructuredName set(String fieldName,
                                Object value)

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








clone
public MetricStructuredName 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
`MetricStructuredName`	`clone()`
`Map<String,String>`	`getContext()` Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection.
`String`	`getName()` Worker-defined metric name.
`String`	`getOrigin()` Origin (namespace) of metric name.
`MetricStructuredName`	`set(String fieldName, Object value)`
`MetricStructuredName`	`setContext(Map<String,String> context)` Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection.
`MetricStructuredName`	`setName(String name)` Worker-defined metric name.
`MetricStructuredName`	`setOrigin(String origin)` Origin (namespace) of metric name.