Package com.google.dataflow.v1beta3

Interface MetricUpdateOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    MetricUpdate, MetricUpdate.Builder
    public interface MetricUpdateOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getCumulative()
      True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
      com.google.protobuf.Value getDistribution()
      A struct value describing properties of a distribution of numeric values.
      com.google.protobuf.ValueOrBuilder getDistributionOrBuilder()
      A struct value describing properties of a distribution of numeric values.
      com.google.protobuf.Value getGauge()
      A struct value describing properties of a Gauge.
      com.google.protobuf.ValueOrBuilder getGaugeOrBuilder()
      A struct value describing properties of a Gauge.
      com.google.protobuf.Value getInternal()
      Worker-computed aggregate value for internal use by the Dataflow service.
      com.google.protobuf.ValueOrBuilder getInternalOrBuilder()
      Worker-computed aggregate value for internal use by the Dataflow service.
      String getKind()
      Metric aggregation kind.
      com.google.protobuf.ByteString getKindBytes()
      Metric aggregation kind.
      com.google.protobuf.Value getMeanCount()
      Worker-computed aggregate value for the "Mean" aggregation kind.
      com.google.protobuf.ValueOrBuilder getMeanCountOrBuilder()
      Worker-computed aggregate value for the "Mean" aggregation kind.
      com.google.protobuf.Value getMeanSum()
      Worker-computed aggregate value for the "Mean" aggregation kind.
      com.google.protobuf.ValueOrBuilder getMeanSumOrBuilder()
      Worker-computed aggregate value for the "Mean" aggregation kind.
      MetricStructuredName getName()
      Name of the metric.
      MetricStructuredNameOrBuilder getNameOrBuilder()
      Name of the metric.
      com.google.protobuf.Value getScalar()
      Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
      com.google.protobuf.ValueOrBuilder getScalarOrBuilder()
      Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
      com.google.protobuf.Value getSet()
      Worker-computed aggregate value for the "Set" aggregation kind.
      com.google.protobuf.ValueOrBuilder getSetOrBuilder()
      Worker-computed aggregate value for the "Set" aggregation kind.
      com.google.protobuf.Timestamp getUpdateTime()
      Timestamp associated with the metric value.
      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
      Timestamp associated with the metric value.
      boolean hasDistribution()
      A struct value describing properties of a distribution of numeric values.
      boolean hasGauge()
      A struct value describing properties of a Gauge.
      boolean hasInternal()
      Worker-computed aggregate value for internal use by the Dataflow service.
      boolean hasMeanCount()
      Worker-computed aggregate value for the "Mean" aggregation kind.
      boolean hasMeanSum()
      Worker-computed aggregate value for the "Mean" aggregation kind.
      boolean hasName()
      Name of the metric.
      boolean hasScalar()
      Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or".
      boolean hasSet()
      Worker-computed aggregate value for the "Set" aggregation kind.
      boolean hasUpdateTime()
      Timestamp associated with the metric value.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasName

        boolean hasName()
         Name of the metric.
        .google.dataflow.v1beta3.MetricStructuredName name = 1;
        Returns:
        Whether the name field is set.

      • getName

        MetricStructuredName getName()
         Name of the metric.
        .google.dataflow.v1beta3.MetricStructuredName name = 1;
        Returns:
        The name.

      • getKind

        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:
        The kind.

      • getKindBytes

        com.google.protobuf.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:
        The bytes for kind.

      • getCumulative

        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:
        The cumulative.

      • hasScalar

        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:
        Whether the scalar field is set.

      • getScalar

        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;
        Returns:
        The scalar.

      • getScalarOrBuilder

        com.google.protobuf.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;

      • hasMeanSum

        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:
        Whether the meanSum field is set.

      • getMeanSum

        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;
        Returns:
        The meanSum.

      • getMeanSumOrBuilder

        com.google.protobuf.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;

      • hasMeanCount

        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:
        Whether the meanCount field is set.

      • getMeanCount

        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;
        Returns:
        The meanCount.

      • getMeanCountOrBuilder

        com.google.protobuf.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;

      • hasSet

        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:
        Whether the set field is set.

      • getSet

        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;
        Returns:
        The set.

      • getSetOrBuilder

        com.google.protobuf.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;

      • hasDistribution

        boolean hasDistribution()
         A struct value describing properties of a distribution of numeric values.
        .google.protobuf.Value distribution = 11;
        Returns:
        Whether the distribution field is set.

      • getDistribution

        com.google.protobuf.Value getDistribution()
         A struct value describing properties of a distribution of numeric values.
        .google.protobuf.Value distribution = 11;
        Returns:
        The distribution.

      • getDistributionOrBuilder

        com.google.protobuf.ValueOrBuilder getDistributionOrBuilder()
         A struct value describing properties of a distribution of numeric values.
        .google.protobuf.Value distribution = 11;

      • hasGauge

        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:
        Whether the gauge field is set.

      • getGauge

        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;
        Returns:
        The gauge.

      • getGaugeOrBuilder

        com.google.protobuf.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;

      • hasInternal

        boolean hasInternal()
         Worker-computed aggregate value for internal use by the Dataflow
 service.
        .google.protobuf.Value internal = 8;
        Returns:
        Whether the internal field is set.

      • getInternal

        com.google.protobuf.Value getInternal()
         Worker-computed aggregate value for internal use by the Dataflow
 service.
        .google.protobuf.Value internal = 8;
        Returns:
        The internal.

      • getInternalOrBuilder

        com.google.protobuf.ValueOrBuilder getInternalOrBuilder()
         Worker-computed aggregate value for internal use by the Dataflow
 service.
        .google.protobuf.Value internal = 8;

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        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;
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.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;