Class MetricUpdate.Builder (0.10.0)

Version 0.10.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public static final class MetricUpdate.Builder extends GeneratedMessageV3.Builder<MetricUpdate.Builder> implements MetricUpdateOrBuilder

Describes the state of a metric.

Protobuf type google.dataflow.v1beta3.MetricUpdate

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > MetricUpdate.Builder

Implements

MetricUpdateOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MetricUpdate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public MetricUpdate build()

Returns

Type	Description
MetricUpdate

buildPartial()

public MetricUpdate buildPartial()

Returns

Type	Description
MetricUpdate

clear()

public MetricUpdate.Builder clear()

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCumulative()

public MetricUpdate.Builder clearCumulative()

True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.

bool cumulative = 3;

Returns

Type	Description
MetricUpdate.Builder	This builder for chaining.

clearDistribution()

public MetricUpdate.Builder clearDistribution()

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Returns

Type	Description
MetricUpdate.Builder

clearField(Descriptors.FieldDescriptor field)

public MetricUpdate.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGauge()

public MetricUpdate.Builder clearGauge()

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Returns

Type	Description
MetricUpdate.Builder

clearInternal()

public MetricUpdate.Builder clearInternal()

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Returns

Type	Description
MetricUpdate.Builder

clearKind()

public MetricUpdate.Builder clearKind()

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.

string kind = 2;

Returns

Type	Description
MetricUpdate.Builder	This builder for chaining.

clearMeanCount()

public MetricUpdate.Builder clearMeanCount()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Returns

Type	Description
MetricUpdate.Builder

clearMeanSum()

public MetricUpdate.Builder clearMeanSum()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Returns

Type	Description
MetricUpdate.Builder

clearName()

public MetricUpdate.Builder clearName()

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Returns

Type	Description
MetricUpdate.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public MetricUpdate.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearScalar()

public MetricUpdate.Builder clearScalar()

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Returns

Type	Description
MetricUpdate.Builder

clearSet()

public MetricUpdate.Builder clearSet()

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Returns

Type	Description
MetricUpdate.Builder

clearUpdateTime()

public MetricUpdate.Builder clearUpdateTime()

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Returns

Type	Description
MetricUpdate.Builder

clone()

public MetricUpdate.Builder clone()

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCumulative()

public boolean getCumulative()

True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.

bool cumulative = 3;

Returns

Type	Description
boolean	The cumulative.

getDefaultInstanceForType()

public MetricUpdate getDefaultInstanceForType()

Returns

Type	Description
MetricUpdate

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDistribution()

public Value getDistribution()

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Returns

Type	Description
Value	The distribution.

getDistributionBuilder()

public Value.Builder getDistributionBuilder()

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Returns

Type	Description
Builder

getDistributionOrBuilder()

public ValueOrBuilder getDistributionOrBuilder()

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Returns

Type	Description
ValueOrBuilder

getGauge()

public Value getGauge()

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Returns

Type	Description
Value	The gauge.

getGaugeBuilder()

public Value.Builder getGaugeBuilder()

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Returns

Type	Description
Builder

getGaugeOrBuilder()

public ValueOrBuilder getGaugeOrBuilder()

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Returns

Type	Description
ValueOrBuilder

getInternal()

public Value getInternal()

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Returns

Type	Description
Value	The internal.

getInternalBuilder()

public Value.Builder getInternalBuilder()

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Returns

Type	Description
Builder

getInternalOrBuilder()

public ValueOrBuilder getInternalOrBuilder()

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Returns

Type	Description
ValueOrBuilder

getKind()

public String getKind()

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.

string kind = 2;

Returns

Type	Description
String	The kind.

getKindBytes()

public ByteString getKindBytes()

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.

string kind = 2;

Returns

Type	Description
ByteString	The bytes for kind.

getMeanCount()

public Value getMeanCount()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Returns

Type	Description
Value	The meanCount.

getMeanCountBuilder()

public Value.Builder getMeanCountBuilder()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Returns

Type	Description
Builder

getMeanCountOrBuilder()

public ValueOrBuilder getMeanCountOrBuilder()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Returns

Type	Description
ValueOrBuilder

getMeanSum()

public Value getMeanSum()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Returns

Type	Description
Value	The meanSum.

getMeanSumBuilder()

public Value.Builder getMeanSumBuilder()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Returns

Type	Description
Builder

getMeanSumOrBuilder()

public ValueOrBuilder getMeanSumOrBuilder()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Returns

Type	Description
ValueOrBuilder

getName()

public MetricStructuredName getName()

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Returns

Type	Description
MetricStructuredName	The name.

getNameBuilder()

public MetricStructuredName.Builder getNameBuilder()

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Returns

Type	Description
MetricStructuredName.Builder

getNameOrBuilder()

public MetricStructuredNameOrBuilder getNameOrBuilder()

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Returns

Type	Description
MetricStructuredNameOrBuilder

getScalar()

public Value getScalar()

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Returns

Type	Description
Value	The scalar.

getScalarBuilder()

public Value.Builder getScalarBuilder()

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Returns

Type	Description
Builder

getScalarOrBuilder()

public ValueOrBuilder getScalarOrBuilder()

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Returns

Type	Description
ValueOrBuilder

getSet()

public Value getSet()

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Returns

Type	Description
Value	The set.

getSetBuilder()

public Value.Builder getSetBuilder()

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Returns

Type	Description
Builder

getSetOrBuilder()

public ValueOrBuilder getSetOrBuilder()

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Returns

Type	Description
ValueOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Returns

Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Returns

Type	Description
TimestampOrBuilder

hasDistribution()

public boolean hasDistribution()

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Returns

Type	Description
boolean	Whether the distribution field is set.

hasGauge()

public boolean hasGauge()

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Returns

Type	Description
boolean	Whether the gauge field is set.

hasInternal()

public boolean hasInternal()

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Returns

Type	Description
boolean	Whether the internal field is set.

hasMeanCount()

public boolean hasMeanCount()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Returns

Type	Description
boolean	Whether the meanCount field is set.

hasMeanSum()

public boolean hasMeanSum()

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Returns

Type	Description
boolean	Whether the meanSum field is set.

hasName()

public boolean hasName()

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Returns

Type	Description
boolean	Whether the name field is set.

hasScalar()

public boolean hasScalar()

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Returns

Type	Description
boolean	Whether the scalar field is set.

hasSet()

public boolean hasSet()

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Returns

Type	Description
boolean	Whether the set field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Returns

Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDistribution(Value value)

public MetricUpdate.Builder mergeDistribution(Value value)

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

mergeFrom(MetricUpdate other)

public MetricUpdate.Builder mergeFrom(MetricUpdate other)

Parameter

Name	Description
other	MetricUpdate

Returns

Type	Description
MetricUpdate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MetricUpdate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
MetricUpdate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public MetricUpdate.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
MetricUpdate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeGauge(Value value)

public MetricUpdate.Builder mergeGauge(Value value)

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

mergeInternal(Value value)

public MetricUpdate.Builder mergeInternal(Value value)

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

mergeMeanCount(Value value)

public MetricUpdate.Builder mergeMeanCount(Value value)

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

mergeMeanSum(Value value)

public MetricUpdate.Builder mergeMeanSum(Value value)

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

mergeName(MetricStructuredName value)

public MetricUpdate.Builder mergeName(MetricStructuredName value)

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Parameter

Name	Description
value	MetricStructuredName

Returns

Type	Description
MetricUpdate.Builder

mergeScalar(Value value)

public MetricUpdate.Builder mergeScalar(Value value)

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

mergeSet(Value value)

public MetricUpdate.Builder mergeSet(Value value)

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MetricUpdate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public MetricUpdate.Builder mergeUpdateTime(Timestamp value)

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
MetricUpdate.Builder

setCumulative(boolean value)

public MetricUpdate.Builder setCumulative(boolean value)

True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.

bool cumulative = 3;

Parameter

Name	Description
value	boolean The cumulative to set.

Returns

Type	Description
MetricUpdate.Builder	This builder for chaining.

setDistribution(Value value)

public MetricUpdate.Builder setDistribution(Value value)

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

setDistribution(Value.Builder builderForValue)

public MetricUpdate.Builder setDistribution(Value.Builder builderForValue)

A struct value describing properties of a distribution of numeric values.

.google.protobuf.Value distribution = 11;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public MetricUpdate.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGauge(Value value)

public MetricUpdate.Builder setGauge(Value value)

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

setGauge(Value.Builder builderForValue)

public MetricUpdate.Builder setGauge(Value.Builder builderForValue)

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

.google.protobuf.Value gauge = 12;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder

setInternal(Value value)

public MetricUpdate.Builder setInternal(Value value)

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

setInternal(Value.Builder builderForValue)

public MetricUpdate.Builder setInternal(Value.Builder builderForValue)

Worker-computed aggregate value for internal use by the Dataflow service.

.google.protobuf.Value internal = 8;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder

setKind(String value)

public MetricUpdate.Builder setKind(String value)

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.

string kind = 2;

Parameter

Name	Description
value	String The kind to set.

Returns

Type	Description
MetricUpdate.Builder	This builder for chaining.

setKindBytes(ByteString value)

public MetricUpdate.Builder setKindBytes(ByteString value)

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.

string kind = 2;

Parameter

Name	Description
value	ByteString The bytes for kind to set.

Returns

Type	Description
MetricUpdate.Builder	This builder for chaining.

setMeanCount(Value value)

public MetricUpdate.Builder setMeanCount(Value value)

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

setMeanCount(Value.Builder builderForValue)

public MetricUpdate.Builder setMeanCount(Value.Builder builderForValue)

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

.google.protobuf.Value mean_count = 6;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder

setMeanSum(Value value)

public MetricUpdate.Builder setMeanSum(Value value)

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

setMeanSum(Value.Builder builderForValue)

public MetricUpdate.Builder setMeanSum(Value.Builder builderForValue)

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

.google.protobuf.Value mean_sum = 5;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder

setName(MetricStructuredName value)

public MetricUpdate.Builder setName(MetricStructuredName value)

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Parameter

Name	Description
value	MetricStructuredName

Returns

Type	Description
MetricUpdate.Builder

setName(MetricStructuredName.Builder builderForValue)

public MetricUpdate.Builder setName(MetricStructuredName.Builder builderForValue)

Name of the metric.

.google.dataflow.v1beta3.MetricStructuredName name = 1;

Parameter

Name	Description
builderForValue	MetricStructuredName.Builder

Returns

Type	Description
MetricUpdate.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setScalar(Value value)

public MetricUpdate.Builder setScalar(Value value)

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

setScalar(Value.Builder builderForValue)

public MetricUpdate.Builder setScalar(Value.Builder builderForValue)

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

.google.protobuf.Value scalar = 4;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder

setSet(Value value)

public MetricUpdate.Builder setSet(Value value)

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Parameter

Name	Description
value	Value

Returns

Type	Description
MetricUpdate.Builder

setSet(Value.Builder builderForValue)

public MetricUpdate.Builder setSet(Value.Builder builderForValue)

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

.google.protobuf.Value set = 7;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final MetricUpdate.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
MetricUpdate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public MetricUpdate.Builder setUpdateTime(Timestamp value)

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
MetricUpdate.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public MetricUpdate.Builder setUpdateTime(Timestamp.Builder builderForValue)

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

.google.protobuf.Timestamp update_time = 9;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
MetricUpdate.Builder