Class: Google::Apis::MonitoringV1::PickTimeSeriesFilter

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

Overview

Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter.

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

Returns a new instance of PickTimeSeriesFilter.



575
576
577
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 575

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

Instance Attribute Details

#direction ⇒ String

How to use the ranking to select time series that pass through the filter. Corresponds to the JSON property direction

Returns:

  • (String) 


562
563
564
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 562

def direction
  @direction
end

#num_time_series ⇒ Fixnum

How many time series to allow to pass through the filter. Corresponds to the JSON property numTimeSeries

Returns:

  • (Fixnum) 


567
568
569
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 567

def num_time_series
  @num_time_series
end

#ranking_method ⇒ String

ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Corresponds to the JSON property rankingMethod

Returns:

  • (String) 


573
574
575
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 573

def ranking_method
  @ranking_method
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



580
581
582
583
584
 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 580

def update!(**args)
  @direction = args[:direction] if args.key?(:direction)
  @num_time_series = args[:num_time_series] if args.key?(:num_time_series)
  @ranking_method = args[:ranking_method] if args.key?(:ranking_method)
end