Class MetricUpdate (0.46.0)

public final class MetricUpdate extends GeneratedMessageV3 implements MetricUpdateOrBuilder

Describes the state of a metric.

Protobuf type google.dataflow.v1beta3.MetricUpdate

Static Fields

CUMULATIVE_FIELD_NUMBER

public static final int CUMULATIVE_FIELD_NUMBER
Field Value
Type Description
int

DISTRIBUTION_FIELD_NUMBER

public static final int DISTRIBUTION_FIELD_NUMBER
Field Value
Type Description
int

GAUGE_FIELD_NUMBER

public static final int GAUGE_FIELD_NUMBER
Field Value
Type Description
int

INTERNAL_FIELD_NUMBER

public static final int INTERNAL_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

MEAN_COUNT_FIELD_NUMBER

public static final int MEAN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

MEAN_SUM_FIELD_NUMBER

public static final int MEAN_SUM_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCALAR_FIELD_NUMBER

public static final int SCALAR_FIELD_NUMBER
Field Value
Type Description
int

SET_FIELD_NUMBER

public static final int SET_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetricUpdate getDefaultInstance()
Returns
Type Description
MetricUpdate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MetricUpdate.Builder newBuilder()
Returns
Type Description
MetricUpdate.Builder

newBuilder(MetricUpdate prototype)

public static MetricUpdate.Builder newBuilder(MetricUpdate prototype)
Parameter
Name Description
prototype MetricUpdate
Returns
Type Description
MetricUpdate.Builder

parseDelimitedFrom(InputStream input)

public static MetricUpdate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricUpdate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricUpdate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricUpdate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetricUpdate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetricUpdate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetricUpdate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricUpdate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetricUpdate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetricUpdate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetricUpdate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricUpdate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetricUpdate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetricUpdate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricUpdate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricUpdate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetricUpdate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricUpdate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricUpdate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricUpdate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetricUpdate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetricUpdate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetricUpdate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricUpdate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetricUpdate> parser()
Returns
Type Description
Parser<MetricUpdate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
boolean

The cumulative.

getDefaultInstanceForType()

public MetricUpdate getDefaultInstanceForType()
Returns
Type Description
MetricUpdate

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.

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.

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.

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.

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.

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.

getNameOrBuilder()

public MetricStructuredNameOrBuilder getNameOrBuilder()

Name of the metric.

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

Returns
Type Description
MetricStructuredNameOrBuilder

getParserForType()

public Parser<MetricUpdate> getParserForType()
Returns
Type Description
Parser<MetricUpdate>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetricUpdate.Builder newBuilderForType()
Returns
Type Description
MetricUpdate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetricUpdate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetricUpdate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MetricUpdate.Builder toBuilder()
Returns
Type Description
MetricUpdate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException