public static final class MetricStructuredName.Builder extends GeneratedMessageV3.Builder<MetricStructuredName.Builder> implements MetricStructuredNameOrBuilder
Identifies a metric, by describing the source which generated the
metric.
Protobuf type google.dataflow.v1beta3.MetricStructuredName
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public MetricStructuredName.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public MetricStructuredName build()
Returns
buildPartial()
public MetricStructuredName buildPartial()
Returns
clear()
public MetricStructuredName.Builder clear()
Returns
Overrides
clearContext()
public MetricStructuredName.Builder clearContext()
Returns
clearField(Descriptors.FieldDescriptor field)
public MetricStructuredName.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public MetricStructuredName.Builder clearName()
Worker-defined metric name.
string name = 2;
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public MetricStructuredName.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearOrigin()
public MetricStructuredName.Builder clearOrigin()
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
clone()
public MetricStructuredName.Builder clone()
Returns
Overrides
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
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
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getMutableContext()
public Map<String,String> getMutableContext()
Use alternate mutation accessors instead.
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
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(MetricStructuredName other)
public MetricStructuredName.Builder mergeFrom(MetricStructuredName other)
Parameter
Returns
public MetricStructuredName.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public MetricStructuredName.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final MetricStructuredName.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
putAllContext(Map<String,String> values)
public MetricStructuredName.Builder putAllContext(Map<String,String> values)
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
putContext(String key, String value)
public MetricStructuredName.Builder putContext(String key, String value)
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
removeContext(String key)
public MetricStructuredName.Builder removeContext(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
setField(Descriptors.FieldDescriptor field, Object value)
public MetricStructuredName.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
public MetricStructuredName.Builder setName(String value)
Worker-defined metric name.
string name = 2;
Parameter
Name | Description |
value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public MetricStructuredName.Builder setNameBytes(ByteString value)
Worker-defined metric name.
string name = 2;
Parameter
Name | Description |
value | ByteString
The bytes for name to set.
|
Returns
setOrigin(String value)
public MetricStructuredName.Builder setOrigin(String value)
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;
Parameter
Name | Description |
value | String
The origin to set.
|
Returns
setOriginBytes(ByteString value)
public MetricStructuredName.Builder setOriginBytes(ByteString value)
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;
Parameter
Name | Description |
value | ByteString
The bytes for origin to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public MetricStructuredName.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final MetricStructuredName.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides