Package io.opentelemetry.proto.metrics.v1

Interface ResourceMetricsOrBuilder

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

    • Method Detail

      • hasResource

        boolean hasResource()
         The resource for the metrics in this message.
 If this field is not set then no resource info is known.
        .opentelemetry.proto.resource.v1.Resource resource = 1;
        Returns:
        Whether the resource field is set.

      • getResource

        Resource getResource()
         The resource for the metrics in this message.
 If this field is not set then no resource info is known.
        .opentelemetry.proto.resource.v1.Resource resource = 1;
        Returns:
        The resource.

      • getResourceOrBuilder

        ResourceOrBuilder getResourceOrBuilder()
         The resource for the metrics in this message.
 If this field is not set then no resource info is known.
        .opentelemetry.proto.resource.v1.Resource resource = 1;

      • getScopeMetricsList

        List<ScopeMetrics> getScopeMetricsList()
         A list of metrics that originate from a resource.
        repeated .opentelemetry.proto.metrics.v1.ScopeMetrics scope_metrics = 2;

      • getScopeMetrics

        ScopeMetrics getScopeMetrics​(int index)
         A list of metrics that originate from a resource.
        repeated .opentelemetry.proto.metrics.v1.ScopeMetrics scope_metrics = 2;

      • getScopeMetricsCount

        int getScopeMetricsCount()
         A list of metrics that originate from a resource.
        repeated .opentelemetry.proto.metrics.v1.ScopeMetrics scope_metrics = 2;

      • getScopeMetricsOrBuilderList

        List<? extends ScopeMetricsOrBuilder> getScopeMetricsOrBuilderList()
         A list of metrics that originate from a resource.
        repeated .opentelemetry.proto.metrics.v1.ScopeMetrics scope_metrics = 2;

      • getScopeMetricsOrBuilder

        ScopeMetricsOrBuilder getScopeMetricsOrBuilder​(int index)
         A list of metrics that originate from a resource.
        repeated .opentelemetry.proto.metrics.v1.ScopeMetrics scope_metrics = 2;

      • getInstrumentationLibraryMetricsList

        @Deprecated
List<InstrumentationLibraryMetrics> getInstrumentationLibraryMetricsList()
        Deprecated.
         A list of InstrumentationLibraryMetrics that originate from a resource.
 This field is deprecated and will be removed after grace period expires on June 15, 2022.
 During the grace period the following rules SHOULD be followed:
 For Binary Protobufs
 ====================
 Binary Protobuf senders SHOULD NOT set instrumentation_library_metrics. Instead
 scope_metrics SHOULD be set.
 Binary Protobuf receivers SHOULD check if instrumentation_library_metrics is set
 and scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics SHOULD be ignored.
 For JSON
 ========
 JSON senders that set instrumentation_library_metrics field MAY also set
 scope_metrics to carry the same metrics, essentially double-publishing the same data.
 Such double-publishing MAY be controlled by a user-settable option.
 If double-publishing is not used then the senders SHOULD set scope_metrics and
 SHOULD NOT set instrumentation_library_metrics.
 JSON receivers SHOULD check if instrumentation_library_metrics is set and
 scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics field SHOULD be ignored.
        repeated .opentelemetry.proto.metrics.v1.InstrumentationLibraryMetrics instrumentation_library_metrics = 1000 [deprecated = true];

      • getInstrumentationLibraryMetrics

        @Deprecated
InstrumentationLibraryMetrics getInstrumentationLibraryMetrics​(int index)
        Deprecated.
         A list of InstrumentationLibraryMetrics that originate from a resource.
 This field is deprecated and will be removed after grace period expires on June 15, 2022.
 During the grace period the following rules SHOULD be followed:
 For Binary Protobufs
 ====================
 Binary Protobuf senders SHOULD NOT set instrumentation_library_metrics. Instead
 scope_metrics SHOULD be set.
 Binary Protobuf receivers SHOULD check if instrumentation_library_metrics is set
 and scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics SHOULD be ignored.
 For JSON
 ========
 JSON senders that set instrumentation_library_metrics field MAY also set
 scope_metrics to carry the same metrics, essentially double-publishing the same data.
 Such double-publishing MAY be controlled by a user-settable option.
 If double-publishing is not used then the senders SHOULD set scope_metrics and
 SHOULD NOT set instrumentation_library_metrics.
 JSON receivers SHOULD check if instrumentation_library_metrics is set and
 scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics field SHOULD be ignored.
        repeated .opentelemetry.proto.metrics.v1.InstrumentationLibraryMetrics instrumentation_library_metrics = 1000 [deprecated = true];

      • getInstrumentationLibraryMetricsCount

        @Deprecated
int getInstrumentationLibraryMetricsCount()
        Deprecated.
         A list of InstrumentationLibraryMetrics that originate from a resource.
 This field is deprecated and will be removed after grace period expires on June 15, 2022.
 During the grace period the following rules SHOULD be followed:
 For Binary Protobufs
 ====================
 Binary Protobuf senders SHOULD NOT set instrumentation_library_metrics. Instead
 scope_metrics SHOULD be set.
 Binary Protobuf receivers SHOULD check if instrumentation_library_metrics is set
 and scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics SHOULD be ignored.
 For JSON
 ========
 JSON senders that set instrumentation_library_metrics field MAY also set
 scope_metrics to carry the same metrics, essentially double-publishing the same data.
 Such double-publishing MAY be controlled by a user-settable option.
 If double-publishing is not used then the senders SHOULD set scope_metrics and
 SHOULD NOT set instrumentation_library_metrics.
 JSON receivers SHOULD check if instrumentation_library_metrics is set and
 scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics field SHOULD be ignored.
        repeated .opentelemetry.proto.metrics.v1.InstrumentationLibraryMetrics instrumentation_library_metrics = 1000 [deprecated = true];

      • getInstrumentationLibraryMetricsOrBuilderList

        @Deprecated
List<? extends InstrumentationLibraryMetricsOrBuilder> getInstrumentationLibraryMetricsOrBuilderList()
        Deprecated.
         A list of InstrumentationLibraryMetrics that originate from a resource.
 This field is deprecated and will be removed after grace period expires on June 15, 2022.
 During the grace period the following rules SHOULD be followed:
 For Binary Protobufs
 ====================
 Binary Protobuf senders SHOULD NOT set instrumentation_library_metrics. Instead
 scope_metrics SHOULD be set.
 Binary Protobuf receivers SHOULD check if instrumentation_library_metrics is set
 and scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics SHOULD be ignored.
 For JSON
 ========
 JSON senders that set instrumentation_library_metrics field MAY also set
 scope_metrics to carry the same metrics, essentially double-publishing the same data.
 Such double-publishing MAY be controlled by a user-settable option.
 If double-publishing is not used then the senders SHOULD set scope_metrics and
 SHOULD NOT set instrumentation_library_metrics.
 JSON receivers SHOULD check if instrumentation_library_metrics is set and
 scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics field SHOULD be ignored.
        repeated .opentelemetry.proto.metrics.v1.InstrumentationLibraryMetrics instrumentation_library_metrics = 1000 [deprecated = true];

      • getInstrumentationLibraryMetricsOrBuilder

        @Deprecated
InstrumentationLibraryMetricsOrBuilder getInstrumentationLibraryMetricsOrBuilder​(int index)
        Deprecated.
         A list of InstrumentationLibraryMetrics that originate from a resource.
 This field is deprecated and will be removed after grace period expires on June 15, 2022.
 During the grace period the following rules SHOULD be followed:
 For Binary Protobufs
 ====================
 Binary Protobuf senders SHOULD NOT set instrumentation_library_metrics. Instead
 scope_metrics SHOULD be set.
 Binary Protobuf receivers SHOULD check if instrumentation_library_metrics is set
 and scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics SHOULD be ignored.
 For JSON
 ========
 JSON senders that set instrumentation_library_metrics field MAY also set
 scope_metrics to carry the same metrics, essentially double-publishing the same data.
 Such double-publishing MAY be controlled by a user-settable option.
 If double-publishing is not used then the senders SHOULD set scope_metrics and
 SHOULD NOT set instrumentation_library_metrics.
 JSON receivers SHOULD check if instrumentation_library_metrics is set and
 scope_metrics is not set then the value in instrumentation_library_metrics
 SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
 If scope_metrics is set then instrumentation_library_metrics field SHOULD be ignored.
        repeated .opentelemetry.proto.metrics.v1.InstrumentationLibraryMetrics instrumentation_library_metrics = 1000 [deprecated = true];

      • getSchemaUrl

        String getSchemaUrl()
         This schema_url applies to the data in the "resource" field. It does not apply
 to the data in the "scope_metrics" field which have their own schema_url field.
        string schema_url = 3;
        Returns:
        The schemaUrl.

      • getSchemaUrlBytes

        com.google.protobuf.ByteString getSchemaUrlBytes()
         This schema_url applies to the data in the "resource" field. It does not apply
 to the data in the "scope_metrics" field which have their own schema_url field.
        string schema_url = 3;
        Returns:
        The bytes for schemaUrl.