Package com.google.dataflow.v1beta3

Class MetricUpdate

  • All Implemented Interfaces:
    MetricUpdateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class MetricUpdate
extends com.google.protobuf.GeneratedMessageV3
implements MetricUpdateOrBuilder
     Describes the state of a metric.
    Protobuf type google.dataflow.v1beta3.MetricUpdate
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MetricUpdate.Builder
      Describes the state of a metric.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      boolean getCumulative()
      True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem.
      static MetricUpdate getDefaultInstance()  
      MetricUpdate getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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.Parser<MetricUpdate> getParserForType()  
      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".
      int getSerializedSize()  
      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.
      int hashCode()  
      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.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static MetricUpdate.Builder newBuilder()  
      static MetricUpdate.Builder newBuilder​(MetricUpdate prototype)  
      MetricUpdate.Builder newBuilderForType()  
      protected MetricUpdate.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static MetricUpdate parseDelimitedFrom​(InputStream input)  
      static MetricUpdate parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetricUpdate parseFrom​(byte[] data)  
      static MetricUpdate parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetricUpdate parseFrom​(com.google.protobuf.ByteString data)  
      static MetricUpdate parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetricUpdate parseFrom​(com.google.protobuf.CodedInputStream input)  
      static MetricUpdate parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetricUpdate parseFrom​(InputStream input)  
      static MetricUpdate parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetricUpdate parseFrom​(ByteBuffer data)  
      static MetricUpdate parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<MetricUpdate> parser()  
      MetricUpdate.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasName

        public boolean hasName()
         Name of the metric.
        .google.dataflow.v1beta3.MetricStructuredName name = 1;
        Specified by:
        hasName in interface MetricUpdateOrBuilder
        Returns:
        Whether the name field is set.

      • 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;
        Specified by:
        getKind in interface MetricUpdateOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public 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;
        Specified by:
        getKindBytes in interface MetricUpdateOrBuilder
        Returns:
        The bytes for kind.

      • 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;
        Specified by:
        getCumulative in interface MetricUpdateOrBuilder
        Returns:
        The cumulative.

      • 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;
        Specified by:
        hasScalar in interface MetricUpdateOrBuilder
        Returns:
        Whether the scalar field is set.

      • getScalar

        public 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;
        Specified by:
        getScalar in interface MetricUpdateOrBuilder
        Returns:
        The scalar.

      • getScalarOrBuilder

        public 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;
        Specified by:
        getScalarOrBuilder in interface MetricUpdateOrBuilder

      • 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;
        Specified by:
        hasMeanSum in interface MetricUpdateOrBuilder
        Returns:
        Whether the meanSum field is set.

      • getMeanSum

        public 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;
        Specified by:
        getMeanSum in interface MetricUpdateOrBuilder
        Returns:
        The meanSum.

      • getMeanSumOrBuilder

        public 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;
        Specified by:
        getMeanSumOrBuilder in interface MetricUpdateOrBuilder

      • 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;
        Specified by:
        hasMeanCount in interface MetricUpdateOrBuilder
        Returns:
        Whether the meanCount field is set.

      • getMeanCount

        public 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;
        Specified by:
        getMeanCount in interface MetricUpdateOrBuilder
        Returns:
        The meanCount.

      • getMeanCountOrBuilder

        public 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;
        Specified by:
        getMeanCountOrBuilder in interface MetricUpdateOrBuilder

      • 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;
        Specified by:
        hasSet in interface MetricUpdateOrBuilder
        Returns:
        Whether the set field is set.

      • getSet

        public 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;
        Specified by:
        getSet in interface MetricUpdateOrBuilder
        Returns:
        The set.

      • getSetOrBuilder

        public 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;
        Specified by:
        getSetOrBuilder in interface MetricUpdateOrBuilder

      • hasDistribution

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

      • getDistribution

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

      • getDistributionOrBuilder

        public com.google.protobuf.ValueOrBuilder getDistributionOrBuilder()
         A struct value describing properties of a distribution of numeric values.
        .google.protobuf.Value distribution = 11;
        Specified by:
        getDistributionOrBuilder in interface MetricUpdateOrBuilder

      • 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;
        Specified by:
        hasGauge in interface MetricUpdateOrBuilder
        Returns:
        Whether the gauge field is set.

      • getGauge

        public 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;
        Specified by:
        getGauge in interface MetricUpdateOrBuilder
        Returns:
        The gauge.

      • getGaugeOrBuilder

        public 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;
        Specified by:
        getGaugeOrBuilder in interface MetricUpdateOrBuilder

      • hasInternal

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

      • getInternal

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

      • getInternalOrBuilder

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

      • 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;
        Specified by:
        hasUpdateTime in interface MetricUpdateOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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;
        Specified by:
        getUpdateTime in interface MetricUpdateOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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;
        Specified by:
        getUpdateTimeOrBuilder in interface MetricUpdateOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static MetricUpdate parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricUpdate parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricUpdate parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricUpdate parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricUpdate parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricUpdate parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricUpdate parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public MetricUpdate.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public MetricUpdate.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected MetricUpdate.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static MetricUpdate getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<MetricUpdate> parser()

      • getParserForType

        public com.google.protobuf.Parser<MetricUpdate> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public MetricUpdate getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder