Class: Google::Api::MetricDescriptor::MetricDescriptorMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/metric.rb

Overview

Additional annotations that can be used to guide the usage of a metric.

Defined Under Namespace

Modules: TimeSeriesResourceHierarchyLevel

Instance Attribute Summary collapse

Instance Attribute Details

#ingest_delay::Google::Protobuf::Duration

Returns The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

Returns:

  • (::Google::Protobuf::Duration)

    The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'proto_docs/google/api/metric.rb', line 206

class MetricDescriptorMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource hierarchy level of the timeseries data of a metric.
  module TimeSeriesResourceHierarchyLevel
    # Do not use this default value.
    TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0

    # Scopes a metric to a project.
    PROJECT = 1

    # Scopes a metric to an organization.
    ORGANIZATION = 2

    # Scopes a metric to a folder.
    FOLDER = 3
  end
end

#launch_stage::Google::Api::LaunchStage

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated. Must use the MetricDescriptor.launch_stage instead.

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'proto_docs/google/api/metric.rb', line 206

class MetricDescriptorMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource hierarchy level of the timeseries data of a metric.
  module TimeSeriesResourceHierarchyLevel
    # Do not use this default value.
    TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0

    # Scopes a metric to a project.
    PROJECT = 1

    # Scopes a metric to an organization.
    ORGANIZATION = 2

    # Scopes a metric to a folder.
    FOLDER = 3
  end
end

#sample_period::Google::Protobuf::Duration

Returns The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

Returns:

  • (::Google::Protobuf::Duration)

    The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'proto_docs/google/api/metric.rb', line 206

class MetricDescriptorMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource hierarchy level of the timeseries data of a metric.
  module TimeSeriesResourceHierarchyLevel
    # Do not use this default value.
    TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0

    # Scopes a metric to a project.
    PROJECT = 1

    # Scopes a metric to an organization.
    ORGANIZATION = 2

    # Scopes a metric to a folder.
    FOLDER = 3
  end
end

#time_series_resource_hierarchy_level::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>

Returns The scope of the timeseries data of the metric.

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'proto_docs/google/api/metric.rb', line 206

class MetricDescriptorMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource hierarchy level of the timeseries data of a metric.
  module TimeSeriesResourceHierarchyLevel
    # Do not use this default value.
    TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0

    # Scopes a metric to a project.
    PROJECT = 1

    # Scopes a metric to an organization.
    ORGANIZATION = 2

    # Scopes a metric to a folder.
    FOLDER = 3
  end
end