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
Static Fields
CONTEXT_FIELD_NUMBER
public static final int CONTEXT_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
ORIGIN_FIELD_NUMBER
public static final int ORIGIN_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static MetricStructuredName getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static MetricStructuredName.Builder newBuilder()
Returns
newBuilder(MetricStructuredName prototype)
public static MetricStructuredName.Builder newBuilder(MetricStructuredName prototype)
Parameter
Returns
public static MetricStructuredName parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static MetricStructuredName parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static MetricStructuredName parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MetricStructuredName parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static MetricStructuredName parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MetricStructuredName parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MetricStructuredName parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static MetricStructuredName parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MetricStructuredName parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static MetricStructuredName parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static MetricStructuredName parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MetricStructuredName parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<MetricStructuredName> parser()
Returns
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
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getContext()
public Map<String,String> getContext()
Returns
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
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;
Returns
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;
Parameters
Returns
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
Returns
getDefaultInstanceForType()
public MetricStructuredName getDefaultInstanceForType()
Returns
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
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
getParserForType()
public Parser<MetricStructuredName> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public MetricStructuredName.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MetricStructuredName.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public MetricStructuredName.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions