Class: Google::Apis::DiscoveryengineV1beta::GoogleMonitoringV3TimeSeries

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/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

Constructor Details

#initialize(**args) ⇒ GoogleMonitoringV3TimeSeries

Returns a new instance of GoogleMonitoringV3TimeSeries.



35489
35490
35491
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35489

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

Instance Attribute Details

#description ⇒ String

Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. Corresponds to the JSON property description

Returns:

  • (String) 


35420
35421
35422
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35420

def description
  @description
end

#metadata ⇒ Google::Apis::DiscoveryengineV1beta::GoogleApiMonitoredResourceMetadata

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. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. Corresponds to the JSON property metadata

Returns:



35429
35430
35431
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35429

def metadata
  @metadata
end

#metric ⇒ Google::Apis::DiscoveryengineV1beta::GoogleApiMetric

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

Returns:



35435
35436
35437
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35435

def metric
  @metric
end

#metric_kind ⇒ String

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) 


35446
35447
35448
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35446

def metric_kind
  @metric_kind
end

#points ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleMonitoringV3Point>

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

Returns:



35456
35457
35458
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35456

def points
  @points
end

#resource ⇒ Google::Apis::DiscoveryengineV1beta::GoogleApiMonitoredResource

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 "project_id", " instance_id" and "zone": "type": "gce_instance", "labels": "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" ` Corresponds to the JSON propertyresource`

Returns:



35470
35471
35472
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35470

def resource
  @resource
end

#unit ⇒ String

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty. Corresponds to the JSON property unit

Returns:

  • (String) 


35478
35479
35480
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35478

def unit
  @unit
end

#value_type ⇒ String

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) 


35487
35488
35489
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35487

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



35494
35495
35496
35497
35498
35499
35500
35501
35502
35503
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 35494

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @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)
  @unit = args[:unit] if args.key?(:unit)
  @value_type = args[:value_type] if args.key?(:value_type)
end