Class: Google::Apis::MonitoringV3::TimeSeries

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

Overview

A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.

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) ⇒ TimeSeries

Returns a new instance of TimeSeries



2581
2582
2583
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2581

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

Instance Attribute Details

#metadataGoogle::Apis::MonitoringV3::MonitoredResourceMetadata

Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion pipeline to extract metadata for cloud resources of all types , and stores the metadata in this message. Corresponds to the JSON property metadata



2527
2528
2529
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2527

def 
  @metadata
end

#metricGoogle::Apis::MonitoringV3::Metric

A specific metric, identified by specifying values for all of the labels of a MetricDescriptor. Corresponds to the JSON property metric



2533
2534
2535
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2533

def metric
  @metric
end

#metric_kindString

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. Corresponds to the JSON property metricKind

Returns:

  • (String)


2544
2545
2546
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2544

def metric_kind
  @metric_kind
end

#pointsArray<Google::Apis::MonitoringV3::Point>

The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point' s type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. Corresponds to the JSON property points



2554
2555
2556
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2554

def points
  @points
end

#resourceGoogle::Apis::MonitoringV3::MonitoredResource

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " zone": "type": "gce_instance", "labels": "instance_id": "12345678901234", "zone": "us-central1-a" ` Corresponds to the JSON propertyresource`



2570
2571
2572
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2570

def resource
  @resource
end

#value_typeString

The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. Corresponds to the JSON property valueType

Returns:

  • (String)


2579
2580
2581
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2579

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2586
2587
2588
2589
2590
2591
2592
2593
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2586

def update!(**args)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metric = args[:metric] if args.key?(:metric)
  @metric_kind = args[:metric_kind] if args.key?(:metric_kind)
  @points = args[:points] if args.key?(:points)
  @resource = args[:resource] if args.key?(:resource)
  @value_type = args[:value_type] if args.key?(:value_type)
end