Class: Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/dashboard/v1/common.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.

Defined Under Namespace

Modules: Direction, Method

Instance Attribute Summary collapse

Instance Attribute Details

#direction ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter::Direction

Returns How to use the ranking to select time series that pass through the filter.

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'proto_docs/google/monitoring/dashboard/v1/common.rb', line 392

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

  # The value reducers that can be applied to a `PickTimeSeriesFilter`.
  module Method
    # Not allowed. You must specify a different `Method` if you specify a
    # `PickTimeSeriesFilter`.
    METHOD_UNSPECIFIED = 0

    # Select the mean of all values.
    METHOD_MEAN = 1

    # Select the maximum value.
    METHOD_MAX = 2

    # Select the minimum value.
    METHOD_MIN = 3

    # Compute the sum of all values.
    METHOD_SUM = 4

    # Select the most recent value.
    METHOD_LATEST = 5
  end

  # Describes the ranking directions.
  module Direction
    # Not allowed. You must specify a different `Direction` if you specify a
    # `PickTimeSeriesFilter`.
    DIRECTION_UNSPECIFIED = 0

    # Pass the highest `num_time_series` ranking inputs.
    TOP = 1

    # Pass the lowest `num_time_series` ranking inputs.
    BOTTOM = 2
  end
end

#num_time_series ⇒ ::Integer

Returns How many time series to allow to pass through the filter.

Returns:

  • (::Integer) —

    How many time series to allow to pass through the filter.



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'proto_docs/google/monitoring/dashboard/v1/common.rb', line 392

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

  # The value reducers that can be applied to a `PickTimeSeriesFilter`.
  module Method
    # Not allowed. You must specify a different `Method` if you specify a
    # `PickTimeSeriesFilter`.
    METHOD_UNSPECIFIED = 0

    # Select the mean of all values.
    METHOD_MEAN = 1

    # Select the maximum value.
    METHOD_MAX = 2

    # Select the minimum value.
    METHOD_MIN = 3

    # Compute the sum of all values.
    METHOD_SUM = 4

    # Select the most recent value.
    METHOD_LATEST = 5
  end

  # Describes the ranking directions.
  module Direction
    # Not allowed. You must specify a different `Direction` if you specify a
    # `PickTimeSeriesFilter`.
    DIRECTION_UNSPECIFIED = 0

    # Pass the highest `num_time_series` ranking inputs.
    TOP = 1

    # Pass the lowest `num_time_series` ranking inputs.
    BOTTOM = 2
  end
end

#ranking_method ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter::Method

Returns 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.

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'proto_docs/google/monitoring/dashboard/v1/common.rb', line 392

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

  # The value reducers that can be applied to a `PickTimeSeriesFilter`.
  module Method
    # Not allowed. You must specify a different `Method` if you specify a
    # `PickTimeSeriesFilter`.
    METHOD_UNSPECIFIED = 0

    # Select the mean of all values.
    METHOD_MEAN = 1

    # Select the maximum value.
    METHOD_MAX = 2

    # Select the minimum value.
    METHOD_MIN = 3

    # Compute the sum of all values.
    METHOD_SUM = 4

    # Select the most recent value.
    METHOD_LATEST = 5
  end

  # Describes the ranking directions.
  module Direction
    # Not allowed. You must specify a different `Direction` if you specify a
    # `PickTimeSeriesFilter`.
    DIRECTION_UNSPECIFIED = 0

    # Pass the highest `num_time_series` ranking inputs.
    TOP = 1

    # Pass the lowest `num_time_series` ranking inputs.
    BOTTOM = 2
  end
end