Class: Google::Apis::AnalyticsreportingV4::MetricFilter
- Inherits:
-
Object
- Object
- Google::Apis::AnalyticsreportingV4::MetricFilter
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/analyticsreporting_v4/classes.rb,
generated/google/apis/analyticsreporting_v4/representations.rb,
generated/google/apis/analyticsreporting_v4/representations.rb
Overview
MetricFilter specifies the filter on a metric.
Instance Attribute Summary collapse
-
#comparison_value ⇒ String
The value to compare against.
-
#metric_name ⇒ String
The metric that will be filtered on.
-
#not ⇒ Boolean
(also: #not?)
Logical
NOT
operator. -
#operator ⇒ String
Is the metric
EQUAL
,LESS_THAN
orGREATER_THAN
the comparisonValue, the default isEQUAL
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MetricFilter
constructor
A new instance of MetricFilter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MetricFilter
Returns a new instance of MetricFilter
836 837 838 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 836 def initialize(**args) update!(**args) end |
Instance Attribute Details
#comparison_value ⇒ String
The value to compare against.
Corresponds to the JSON property comparisonValue
812 813 814 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 812 def comparison_value @comparison_value end |
#metric_name ⇒ String
The metric that will be filtered on. A metricFilter must contain a metric
name. A metric name can be an alias earlier defined as a metric or it can
also be a metric expression.
Corresponds to the JSON property metricName
819 820 821 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 819 def metric_name @metric_name end |
#not ⇒ Boolean Also known as: not?
Logical NOT
operator. If this boolean is set to true, then the matching
metric values will be excluded in the report. The default is false.
Corresponds to the JSON property not
825 826 827 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 825 def not @not end |
#operator ⇒ String
Is the metric EQUAL
, LESS_THAN
or GREATER_THAN
the
comparisonValue, the default is EQUAL
. If the operator is
IS_MISSING
, checks if the metric is missing and would ignore the
comparisonValue.
Corresponds to the JSON property operator
834 835 836 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 834 def operator @operator end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
841 842 843 844 845 846 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 841 def update!(**args) @comparison_value = args[:comparison_value] if args.key?(:comparison_value) @metric_name = args[:metric_name] if args.key?(:metric_name) @not = args[:not] if args.key?(:not) @operator = args[:operator] if args.key?(:operator) end |