Class: Google::Apis::ServiceusageV1::MetricDescriptorMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MetricDescriptorMetadata

Returns a new instance of MetricDescriptorMetadata



2719
2720
2721
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2719

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ingest_delayString

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. Corresponds to the JSON property ingestDelay

Returns:

  • (String)


2703
2704
2705
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2703

def ingest_delay
  @ingest_delay
end

#launch_stageString

Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. Corresponds to the JSON property launchStage

Returns:

  • (String)


2709
2710
2711
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2709

def launch_stage
  @launch_stage
end

#sample_periodString

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. Corresponds to the JSON property samplePeriod

Returns:

  • (String)


2717
2718
2719
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2717

def sample_period
  @sample_period
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2724
2725
2726
2727
2728
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2724

def update!(**args)
  @ingest_delay = args[:ingest_delay] if args.key?(:ingest_delay)
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
  @sample_period = args[:sample_period] if args.key?(:sample_period)
end