Class MetricStructuredName (0.15.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MetricStructuredName

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()
Returns
Type Description
MetricStructuredName

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MetricStructuredName.Builder newBuilder()
Returns
Type Description
MetricStructuredName.Builder

newBuilder(MetricStructuredName prototype)

public static MetricStructuredName.Builder newBuilder(MetricStructuredName prototype)
Parameter
Name Description
prototype MetricStructuredName
Returns
Type Description
MetricStructuredName.Builder

parseDelimitedFrom(InputStream input)

public static MetricStructuredName parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricStructuredName parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetricStructuredName parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetricStructuredName parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetricStructuredName parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetricStructuredName parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetricStructuredName parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricStructuredName parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetricStructuredName parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricStructuredName parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetricStructuredName parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetricStructuredName parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricStructuredName
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetricStructuredName> parser()
Returns
Type Description
Parser<MetricStructuredName>

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
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContext()

public Map<String,String> getContext()

Use #getContextMap() instead.

Returns
Type Description
Map<String,String>

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;

Returns
Type Description
Map<String,String>

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
Name Description
key String
defaultValue String
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
key String
Returns
Type Description
String

getDefaultInstanceForType()

public MetricStructuredName getDefaultInstanceForType()
Returns
Type Description
MetricStructuredName

getName()

public String 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()
Returns
Type Description
Parser<MetricStructuredName>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetricStructuredName.Builder newBuilderForType()
Returns
Type Description
MetricStructuredName.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetricStructuredName.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetricStructuredName.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MetricStructuredName.Builder toBuilder()
Returns
Type Description
MetricStructuredName.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException