Class MetricUpdate.Builder (0.10.0)

Stay organized with collections Save and categorize content based on your preferences.
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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public MetricUpdate build()
Returns
TypeDescription
MetricUpdate

buildPartial()

public MetricUpdate buildPartial()
Returns
TypeDescription
MetricUpdate

clear()

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

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
TypeDescription
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
TypeDescription
MetricUpdate.Builder

clearField(Descriptors.FieldDescriptor field)

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

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
TypeDescription
MetricUpdate.Builder

clearInternal()

public MetricUpdate.Builder clearInternal()

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

.google.protobuf.Value internal = 8;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
MetricUpdate.Builder

clearName()

public MetricUpdate.Builder clearName()

Name of the metric.

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

Returns
TypeDescription
MetricUpdate.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public MetricUpdate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
MetricUpdate.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
MetricUpdate.Builder

clone()

public MetricUpdate.Builder clone()
Returns
TypeDescription
MetricUpdate.Builder
Overrides

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

The cumulative.

getDefaultInstanceForType()

public MetricUpdate getDefaultInstanceForType()
Returns
TypeDescription
MetricUpdate

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDistribution()

public Value getDistribution()

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

.google.protobuf.Value distribution = 11;

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

getDistributionOrBuilder()

public ValueOrBuilder getDistributionOrBuilder()

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

.google.protobuf.Value distribution = 11;

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

getInternal()

public Value getInternal()

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

.google.protobuf.Value internal = 8;

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

getInternalOrBuilder()

public ValueOrBuilder getInternalOrBuilder()

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

.google.protobuf.Value internal = 8;

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

getName()

public MetricStructuredName getName()

N