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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public MetricStructuredName.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public MetricStructuredName build()
buildPartial()
public MetricStructuredName buildPartial()
clear()
public MetricStructuredName.Builder clear()
Overrides
clearContext()
public MetricStructuredName.Builder clearContext()
clearField(Descriptors.FieldDescriptor field)
public MetricStructuredName.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearName()
public MetricStructuredName.Builder clearName()
Worker-defined metric name.
string name = 2;
clearOneof(Descriptors.OneofDescriptor oneof)
public MetricStructuredName.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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;
clone()
public MetricStructuredName.Builder clone()
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 |
|---|
| Name | Description |
key | String
|
getContext()
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;
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
|
getDefaultInstanceForType()
public MetricStructuredName getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMutableContext()
public Map<String,String> getMutableContext()
Use alternate mutation accessors instead.
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(MetricStructuredName other)
public MetricStructuredName.Builder mergeFrom(MetricStructuredName other)
public MetricStructuredName.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public MetricStructuredName.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final MetricStructuredName.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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;
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;
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 |
|---|
| Name | Description |
key | String
|
setField(Descriptors.FieldDescriptor field, Object value)
public MetricStructuredName.Builder setField(Descriptors.FieldDescriptor field, Object value)
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.
|
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.
|
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.
|
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public MetricStructuredName.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final MetricStructuredName.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
