Class MetricStructuredName.Builder (0.56.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MetricStructuredName.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MetricStructuredName.Builder
Overrides

build()

public MetricStructuredName build()
Returns
Type Description
MetricStructuredName

buildPartial()

public MetricStructuredName buildPartial()
Returns
Type Description
MetricStructuredName

clear()

public MetricStructuredName.Builder clear()
Returns
Type Description
MetricStructuredName.Builder
Overrides

clearContext()

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

clearField(Descriptors.FieldDescriptor field)

public MetricStructuredName.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
MetricStructuredName.Builder
Overrides

clearName()

public MetricStructuredName.Builder clearName()

Worker-defined metric name.

string name = 2;

Returns
Type Description
MetricStructuredName.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public MetricStructuredName.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
MetricStructuredName.Builder

This builder for chaining.

clone()

public MetricStructuredName.Builder clone()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
boolean

getContext() (deprecated)

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableContext() (deprecated)

public Map<String,String> getMutableContext()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetricStructuredName other)

public MetricStructuredName.Builder mergeFrom(MetricStructuredName other)
Parameter
Name Description
other MetricStructuredName
Returns
Type Description
MetricStructuredName.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MetricStructuredName.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricStructuredName.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public MetricStructuredName.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MetricStructuredName.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MetricStructuredName.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
values Map<String,String>
Returns
Type Description
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
Name Description
key String
value String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
MetricStructuredName.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public MetricStructuredName.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MetricStructuredName.Builder
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
Type Description
MetricStructuredName.Builder

This builder for chaining.

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
Type Description
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
Name Description
value String

The origin to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for origin to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
MetricStructuredName.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final MetricStructuredName.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MetricStructuredName.Builder
Overrides