/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/dataflow/v1beta3/metrics.proto
package com.google.dataflow.v1beta3;
public interface MetricUpdateOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.dataflow.v1beta3.MetricUpdate)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Name of the metric.
*
*
* .google.dataflow.v1beta3.MetricStructuredName name = 1;
*
* @return Whether the name field is set.
*/
boolean hasName();
/**
*
*
*
* Name of the metric.
*
*
* .google.dataflow.v1beta3.MetricStructuredName name = 1;
*
* @return The name.
*/
com.google.dataflow.v1beta3.MetricStructuredName getName();
/**
*
*
*
* Name of the metric.
*
*
* .google.dataflow.v1beta3.MetricStructuredName name = 1;
*/
com.google.dataflow.v1beta3.MetricStructuredNameOrBuilder getNameOrBuilder();
/**
*
*
*
* 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;
*
* @return The kind.
*/
java.lang.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;
*
* @return The bytes for kind.
*/
com.google.protobuf.ByteString getKindBytes();
/**
*
*
*
* 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;
*
* @return The cumulative.
*/
boolean getCumulative();
/**
*
*
*
* 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;
*
* @return Whether the scalar field is set.
*/
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;
*
* @return The scalar.
*/
com.google.protobuf.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;
*/
com.google.protobuf.ValueOrBuilder getScalarOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the meanSum field is set.
*/
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;
*
* @return The meanSum.
*/
com.google.protobuf.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;
*/
com.google.protobuf.ValueOrBuilder getMeanSumOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the meanCount field is set.
*/
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;
*
* @return The meanCount.
*/
com.google.protobuf.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;
*/
com.google.protobuf.ValueOrBuilder getMeanCountOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the set field is set.
*/
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;
*
* @return The set.
*/
com.google.protobuf.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;
*/
com.google.protobuf.ValueOrBuilder getSetOrBuilder();
/**
*
*
*
* A struct value describing properties of a distribution of numeric values.
*
*
* .google.protobuf.Value distribution = 11;
*
* @return Whether the distribution field is set.
*/
boolean hasDistribution();
/**
*
*
*
* A struct value describing properties of a distribution of numeric values.
*
*
* .google.protobuf.Value distribution = 11;
*
* @return The distribution.
*/
com.google.protobuf.Value getDistribution();
/**
*
*
*
* A struct value describing properties of a distribution of numeric values.
*
*
* .google.protobuf.Value distribution = 11;
*/
com.google.protobuf.ValueOrBuilder getDistributionOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the gauge field is set.
*/
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;
*
* @return The gauge.
*/
com.google.protobuf.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;
*/
com.google.protobuf.ValueOrBuilder getGaugeOrBuilder();
/**
*
*
*
* Worker-computed aggregate value for internal use by the Dataflow
* service.
*
*
* .google.protobuf.Value internal = 8;
*
* @return Whether the internal field is set.
*/
boolean hasInternal();
/**
*
*
*
* Worker-computed aggregate value for internal use by the Dataflow
* service.
*
*
* .google.protobuf.Value internal = 8;
*
* @return The internal.
*/
com.google.protobuf.Value getInternal();
/**
*
*
*
* Worker-computed aggregate value for internal use by the Dataflow
* service.
*
*
* .google.protobuf.Value internal = 8;
*/
com.google.protobuf.ValueOrBuilder getInternalOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the updateTime field is set.
*/
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;
*
* @return The updateTime.
*/
com.google.protobuf.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;
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
}