com.google.api.services.dataflow.model

Class MetricStructuredName

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

All Implemented Interfaces:

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

Method Summary

Methods

Modifier and Type	Method and Description
MetricStructuredName	clone()
java.util.Map<java.lang.String,java.lang.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.
java.lang.String	getName() Worker-defined metric name.
java.lang.String	getOrigin() Origin (namespace) of metric name.
MetricStructuredName	set(java.lang.String fieldName, java.lang.Object value)
MetricStructuredName	setContext(java.util.Map<java.lang.String,java.lang.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(java.lang.String name) Worker-defined metric name.
MetricStructuredName	setOrigin(java.lang.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, 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

MetricStructuredName

public MetricStructuredName()

Method Detail

getContext

public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 java.lang.String getName()

Worker-defined metric name.

Returns:

value or null for none

setName

public MetricStructuredName setName(java.lang.String name)

Worker-defined metric name.

Parameters:

name - name or null for none

getOrigin

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