Class MetricStructuredName.Builder (0.20.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MetricStructuredName.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MetricStructuredName.Builder
Overrides

build()

public MetricStructuredName build()
Returns
TypeDescription
MetricStructuredName

buildPartial()

public MetricStructuredName buildPartial()
Returns
TypeDescription
MetricStructuredName

clear()

public MetricStructuredName.Builder clear()
Returns
TypeDescription
MetricStructuredName.Builder
Overrides

clearContext()

public MetricStructuredName.Builder clearContext()
Returns
TypeDescription
MetricStructuredName.Builder

clearField(Descriptors.FieldDescriptor field)

public MetricStructuredName.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
MetricStructuredName.Builder
Overrides

clearName()

public MetricStructuredName.Builder clearName()

Worker-defined metric name.

string name = 2;

Returns
TypeDescription
MetricStructuredName.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public MetricStructuredName.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
MetricStructuredName.Builder
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
TypeDescription
MetricStructuredName.Builder

This builder for chaining.

clone()

public MetricStructuredName.Builder clone()
Returns
TypeDescription
MetricStructuredName.Builder
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
NameDescription
keyString
Returns
TypeDescription
boolean

getContext()

public Map<String,String> getContext()

Use #getContextMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public MetricStructuredName getDefaultInstanceForType()
Returns
TypeDescription
MetricStructuredName

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableContext()

public Map<String,String> getMutableContext()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Worker-defined metric name.

string name = 2;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Worker-defined metric name.

string name = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for origin.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(MetricStructuredName other)

public MetricStructuredName.Builder mergeFrom(MetricStructuredName other)
Parameter
NameDescription
otherMetricStructuredName
Returns
TypeDescription
MetricStructuredName.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MetricStructuredName.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MetricStructuredName.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public MetricStructuredName.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
MetricStructuredName.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MetricStructuredName.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MetricStructuredName.Builder
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
MetricStructuredName.Builder

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
NameDescription
keyString
valueString
Returns
TypeDescription
MetricStructuredName.Builder

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
NameDescription
keyString
Returns
TypeDescription
MetricStructuredName.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public MetricStructuredName.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MetricStructuredName.Builder
Overrides

setName(String value)

public MetricStructuredName.Builder setName(String value)

Worker-defined metric name.

string name = 2;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
MetricStructuredName.Builder

This builder for chaining.

setNameBytes(ByteString value)

public MetricStructuredName.Builder setNameBytes(ByteString value)

Worker-defined metric name.

string name = 2;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
MetricStructuredName.Builder

This builder for chaining.

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
NameDescription
valueString

The origin to set.

Returns
TypeDescription
MetricStructuredName.Builder

This builder for chaining.

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
NameDescription
valueByteString

The bytes for origin to set.

Returns
TypeDescription
MetricStructuredName.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public MetricStructuredName.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
MetricStructuredName.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final MetricStructuredName.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MetricStructuredName.Builder
Overrides