Interface MetricUpdateOrBuilder (0.38.0)

Version 0.38.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 interface MetricUpdateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCumulative()

public abstract 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.

getDistribution()

public abstract Value getDistribution()

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

.google.protobuf.Value distribution = 11;

Returns
Type	Description
Value	The distribution.

getDistributionOrBuilder()

public abstract ValueOrBuilder getDistributionOrBuilder()

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

.google.protobuf.Value distribution = 11;

Returns
Type	Description
ValueOrBuilder

getGauge()

public abstract 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.

getGaugeOrBuilder()

public abstract 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 abstract Value getInternal()

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

.google.protobuf.Value internal = 8;

Returns
Type	Description
Value	The internal.

getInternalOrBuilder()

public abstract ValueOrBuilder getInternalOrBuilder()

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

.google.protobuf.Value internal = 8;

Returns
Type	Description
ValueOrBuilder

getKind()

public abstract 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 abstract 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 abstract 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.

getMeanCountOrBuilder()

public abstract 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 abstract 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.

getMeanSumOrBuilder()

public abstract 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 abstract MetricStructuredName getName()

Name of the metric.

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

Returns
Type	Description
MetricStructuredName	The name.

getNameOrBuilder()

public abstract MetricStructuredNameOrBuilder getNameOrBuilder()

Name of the metric.

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

Returns
Type	Description
MetricStructuredNameOrBuilder

getScalar()

public abstract 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.

getScalarOrBuilder()

public abstract 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 abstract 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.

getSetOrBuilder()

public abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasName()

Name of the metric.

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

Returns
Type	Description
boolean	Whether the name field is set.

hasScalar()

public abstract 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 abstract 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 abstract 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.