Package io.opencensus.proto.metrics.v1

Class Metric

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetricOrBuilder, Serializable
    public final class Metric
extends com.google.protobuf.GeneratedMessageV3
implements MetricOrBuilder
     Defines a Metric which has one or more timeseries.
    Protobuf type opencensus.proto.metrics.v1.Metric
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Metric.Builder
      Defines a Metric which has one or more timeseries.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int METRIC_DESCRIPTOR_FIELD_NUMBER  
      static int RESOURCE_FIELD_NUMBER  
      static int TIMESERIES_FIELD_NUMBER  

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

        alwaysUseFieldBuilders, unknownFields

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

        memoizedSize

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

        memoizedHashCode

    • Field Detail

      • METRIC_DESCRIPTOR_FIELD_NUMBER

        public static final int METRIC_DESCRIPTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIMESERIES_FIELD_NUMBER

        public static final int TIMESERIES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasMetricDescriptor

        public boolean hasMetricDescriptor()
         The descriptor of the Metric.
 TODO(issue #152): consider only sending the name of descriptor for
 optimization.
        .opencensus.proto.metrics.v1.MetricDescriptor metric_descriptor = 1;
        Specified by:
        hasMetricDescriptor in interface MetricOrBuilder
        Returns:
        Whether the metricDescriptor field is set.

      • getMetricDescriptor

        public MetricDescriptor getMetricDescriptor()
         The descriptor of the Metric.
 TODO(issue #152): consider only sending the name of descriptor for
 optimization.
        .opencensus.proto.metrics.v1.MetricDescriptor metric_descriptor = 1;
        Specified by:
        getMetricDescriptor in interface MetricOrBuilder
        Returns:
        The metricDescriptor.

      • getMetricDescriptorOrBuilder

        public MetricDescriptorOrBuilder getMetricDescriptorOrBuilder()
         The descriptor of the Metric.
 TODO(issue #152): consider only sending the name of descriptor for
 optimization.
        .opencensus.proto.metrics.v1.MetricDescriptor metric_descriptor = 1;
        Specified by:
        getMetricDescriptorOrBuilder in interface MetricOrBuilder

      • getTimeseriesList

        public List<TimeSeries> getTimeseriesList()
         One or more timeseries for a single metric, where each timeseries has
 one or more points.
        repeated .opencensus.proto.metrics.v1.TimeSeries timeseries = 2;
        Specified by:
        getTimeseriesList in interface MetricOrBuilder

      • getTimeseriesOrBuilderList

        public List<? extends TimeSeriesOrBuilder> getTimeseriesOrBuilderList()
         One or more timeseries for a single metric, where each timeseries has
 one or more points.
        repeated .opencensus.proto.metrics.v1.TimeSeries timeseries = 2;
        Specified by:
        getTimeseriesOrBuilderList in interface MetricOrBuilder

      • getTimeseriesCount

        public int getTimeseriesCount()
         One or more timeseries for a single metric, where each timeseries has
 one or more points.
        repeated .opencensus.proto.metrics.v1.TimeSeries timeseries = 2;
        Specified by:
        getTimeseriesCount in interface MetricOrBuilder

      • getTimeseries

        public TimeSeries getTimeseries​(int index)
         One or more timeseries for a single metric, where each timeseries has
 one or more points.
        repeated .opencensus.proto.metrics.v1.TimeSeries timeseries = 2;
        Specified by:
        getTimeseries in interface MetricOrBuilder

      • getTimeseriesOrBuilder

        public TimeSeriesOrBuilder getTimeseriesOrBuilder​(int index)
         One or more timeseries for a single metric, where each timeseries has
 one or more points.
        repeated .opencensus.proto.metrics.v1.TimeSeries timeseries = 2;
        Specified by:
        getTimeseriesOrBuilder in interface MetricOrBuilder

      • hasResource

        public boolean hasResource()
         The resource for the metric. If unset, it may be set to a default value
 provided for a sequence of messages in an RPC stream.
        .opencensus.proto.resource.v1.Resource resource = 3;
        Specified by:
        hasResource in interface MetricOrBuilder
        Returns:
        Whether the resource field is set.

      • getResource

        public Resource getResource()
         The resource for the metric. If unset, it may be set to a default value
 provided for a sequence of messages in an RPC stream.
        .opencensus.proto.resource.v1.Resource resource = 3;
        Specified by:
        getResource in interface MetricOrBuilder
        Returns:
        The resource.

      • getResourceOrBuilder

        public ResourceOrBuilder getResourceOrBuilder()
         The resource for the metric. If unset, it may be set to a default value
 provided for a sequence of messages in an RPC stream.
        .opencensus.proto.resource.v1.Resource resource = 3;
        Specified by:
        getResourceOrBuilder in interface MetricOrBuilder

      • 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 Metric parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Metric getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Metric> 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 Metric getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder