com.google.api.services.dataflow.model

Class CounterStructuredName

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CounterStructuredName
extends GenericJson

Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job.

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

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
CounterStructuredName()

Method Summary

Modifier and Type	Method and Description
CounterStructuredName	clone()
String	getComponentStepName() Name of the optimized step being executed by the workers.
String	getExecutionStepName() Name of the stage.
Integer	getInputIndex() Index of an input collection that's being read from/written to as a side input.
String	getName() Counter name.
String	getOrigin() One of the standard Origins defined above.
String	getOriginalRequestingStepName() The step name requesting an operation, such as GBK.
String	getOriginalStepName() System generated name of the original step in the user's graph, before optimization.
String	getOriginNamespace() A string containing a more specific namespace of the counter's origin.
String	getPortion() Portion of this counter, either key or value.
String	getWorkerId() ID of a particular worker.
CounterStructuredName	set(String fieldName, Object value)
CounterStructuredName	setComponentStepName(String componentStepName) Name of the optimized step being executed by the workers.
CounterStructuredName	setExecutionStepName(String executionStepName) Name of the stage.
CounterStructuredName	setInputIndex(Integer inputIndex) Index of an input collection that's being read from/written to as a side input.
CounterStructuredName	setName(String name) Counter name.
CounterStructuredName	setOrigin(String origin) One of the standard Origins defined above.
CounterStructuredName	setOriginalRequestingStepName(String originalRequestingStepName) The step name requesting an operation, such as GBK.
CounterStructuredName	setOriginalStepName(String originalStepName) System generated name of the original step in the user's graph, before optimization.
CounterStructuredName	setOriginNamespace(String originNamespace) A string containing a more specific namespace of the counter's origin.
CounterStructuredName	setPortion(String portion) Portion of this counter, either key or value.
CounterStructuredName	setWorkerId(String workerId) ID of a particular worker.

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

CounterStructuredName

public CounterStructuredName()

Method Detail

getComponentStepName

public String getComponentStepName()

Name of the optimized step being executed by the workers.

Returns:

value or null for none

setComponentStepName

public CounterStructuredName setComponentStepName(String componentStepName)

Name of the optimized step being executed by the workers.

Parameters:

componentStepName - componentStepName or null for none

getExecutionStepName

public String getExecutionStepName()

Name of the stage. An execution step contains multiple component steps.

Returns:

value or null for none

setExecutionStepName

public CounterStructuredName setExecutionStepName(String executionStepName)

Name of the stage. An execution step contains multiple component steps.

Parameters:

executionStepName - executionStepName or null for none

getInputIndex

public Integer getInputIndex()

Index of an input collection that's being read from/written to as a side input. The index identifies a step's side inputs starting by 1 (e.g. the first side input has input_index 1, the third has input_index 3). Side inputs are identified by a pair of (original_step_name, input_index). This field helps uniquely identify them.

Returns:

value or null for none

setInputIndex

public CounterStructuredName setInputIndex(Integer inputIndex)

Index of an input collection that's being read from/written to as a side input. The index identifies a step's side inputs starting by 1 (e.g. the first side input has input_index 1, the third has input_index 3). Side inputs are identified by a pair of (original_step_name, input_index). This field helps uniquely identify them.

Parameters:

inputIndex - inputIndex or null for none

getName

public String getName()

Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required.

Returns:

value or null for none

setName

public CounterStructuredName setName(String name)

Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required.

Parameters:

name - name or null for none

getOrigin

public String getOrigin()

One of the standard Origins defined above.

Returns:

value or null for none

setOrigin

public CounterStructuredName setOrigin(String origin)

One of the standard Origins defined above.

Parameters:

origin - origin or null for none

getOriginNamespace

public String getOriginNamespace()

A string containing a more specific namespace of the counter's origin.

Returns:

value or null for none

setOriginNamespace

public CounterStructuredName setOriginNamespace(String originNamespace)

A string containing a more specific namespace of the counter's origin.

Parameters:

originNamespace - originNamespace or null for none

getOriginalRequestingStepName

public String getOriginalRequestingStepName()

The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs.

Returns:

value or null for none

setOriginalRequestingStepName

public CounterStructuredName setOriginalRequestingStepName(String originalRequestingStepName)

The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs.

Parameters:

originalRequestingStepName - originalRequestingStepName or null for none

getOriginalStepName

public String getOriginalStepName()

System generated name of the original step in the user's graph, before optimization.

Returns:

value or null for none

setOriginalStepName

public CounterStructuredName setOriginalStepName(String originalStepName)

System generated name of the original step in the user's graph, before optimization.

Parameters:

originalStepName - originalStepName or null for none

getPortion

public String getPortion()

Portion of this counter, either key or value.

Returns:

value or null for none

setPortion

public CounterStructuredName setPortion(String portion)

Portion of this counter, either key or value.

Parameters:

portion - portion or null for none

getWorkerId

public String getWorkerId()

ID of a particular worker.

Returns:

value or null for none

setWorkerId

public CounterStructuredName setWorkerId(String workerId)

ID of a particular worker.

Parameters:

workerId - workerId or null for none

set

public CounterStructuredName set(String fieldName,
                                 Object value)

Overrides:

set in class GenericJson

clone

public CounterStructuredName clone()

Overrides:

clone in class GenericJson