Class MetricStructuredName (0.79.0)
0.91.0 (latest)
0.89.0
0.87.0
0.86.0
0.85.0
0.84.0
0.82.0
0.80.0
0.79.0
0.78.0
0.77.0
0.76.0
0.74.0
0.72.0
0.71.0
0.68.0
0.67.0
0.66.0
0.64.0
0.63.0
0.62.0
0.61.0
0.60.0
0.59.0
0.58.0
0.57.0
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 final class MetricStructuredName extends GeneratedMessageV3 implements MetricStructuredNameOrBuilder
Identifies a metric, by describing the source which generated the
metric.
Protobuf type google.dataflow.v1beta3.MetricStructuredName
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTEXT_FIELD_NUMBER
public static final int CONTEXT_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
ORIGIN_FIELD_NUMBER
public static final int ORIGIN_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static MetricStructuredName getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static MetricStructuredName . Builder newBuilder ()
newBuilder(MetricStructuredName prototype)
public static MetricStructuredName . Builder newBuilder ( MetricStructuredName prototype )
public static MetricStructuredName parseDelimitedFrom ( InputStream input )
public static MetricStructuredName parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static MetricStructuredName parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MetricStructuredName parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static MetricStructuredName parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MetricStructuredName parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static MetricStructuredName parseFrom ( CodedInputStream input )
public static MetricStructuredName parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static MetricStructuredName parseFrom ( InputStream input )
public static MetricStructuredName parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static MetricStructuredName parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MetricStructuredName parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<MetricStructuredName> parser ()
Methods
containsContext(String key)
public 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
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getContext() (deprecated)
public Map<String , String > getContext ()
getContextCount()
public 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 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;
getContextOrDefault(String key, String defaultValue)
public 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;
Returns
Type Description
String
getContextOrThrow(String key)
public 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
keyString
Returns
Type Description
String
getDefaultInstanceForType()
public MetricStructuredName getDefaultInstanceForType ()
getName()
Worker-defined metric name.
string name = 2;
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Worker-defined metric name.
string name = 2;
Returns
Type Description
ByteString The bytes for name.
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.
string origin = 1;
Returns
Type Description
String The origin.
getOriginBytes()
public 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.
getParserForType()
public Parser<MetricStructuredName> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection ( int number )
Parameter
Name Description
numberint
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public MetricStructuredName . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MetricStructuredName . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public MetricStructuredName . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
