Interface MetricStructuredNameOrBuilder (0.51.0)

Version 0.51.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public interface MetricStructuredNameOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsContext(String key)

public abstract boolean containsContext(String key)

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'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>.

map<string, string> context = 3;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getContext() (deprecated)

public abstract Map<String,String> getContext()

Use #getContextMap() instead.

Returns
Type	Description
Map<String,String>

getContextCount()

public abstract int getContextCount()

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'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>.

map<string, string> context = 3;

Returns
Type	Description
int

getContextMap()

public abstract Map<String,String> getContextMap()

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'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>.

map<string, string> context = 3;

Returns
Type	Description
Map<String,String>

getContextOrDefault(String key, String defaultValue)

public abstract String getContextOrDefault(String key, String defaultValue)

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'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>.

map<string, string> context = 3;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getContextOrThrow(String key)

public abstract String getContextOrThrow(String key)

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'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>.

map<string, string> context = 3;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Worker-defined metric name.

string name = 2;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Worker-defined metric name.

string name = 2;

Returns
Type	Description
ByteString	The bytes for name.

getOrigin()

public abstract 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.

string origin = 1;

Returns
Type	Description
String	The origin.

getOriginBytes()

public abstract ByteString getOriginBytes()

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

string origin = 1;

Returns
Type	Description
ByteString	The bytes for origin.