Class: Google::Apis::AnalyticsreportingV4::DimensionFilter
- Inherits:
-
Object
- Object
- Google::Apis::AnalyticsreportingV4::DimensionFilter
- 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
Dimension filter specifies the filtering options on a dimension.
Instance Attribute Summary collapse
-
#case_sensitive ⇒ Boolean
(also: #case_sensitive?)
Should the match be case sensitive? Default is false.
-
#dimension_name ⇒ String
The dimension to filter on.
-
#expressions ⇒ Array<String>
Strings or regular expression to match against.
-
#not ⇒ Boolean
(also: #not?)
Logical
NOT
operator. -
#operator ⇒ String
How to match the dimension to the expression.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DimensionFilter
constructor
A new instance of DimensionFilter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DimensionFilter
Returns a new instance of DimensionFilter
292 293 294 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 292 def initialize(**args) update!(**args) end |
Instance Attribute Details
#case_sensitive ⇒ Boolean Also known as: case_sensitive?
Should the match be case sensitive? Default is false.
Corresponds to the JSON property caseSensitive
264 265 266 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 264 def case_sensitive @case_sensitive end |
#dimension_name ⇒ String
The dimension to filter on. A DimensionFilter must contain a dimension.
Corresponds to the JSON property dimensionName
270 271 272 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 270 def dimension_name @dimension_name end |
#expressions ⇒ Array<String>
Strings or regular expression to match against. Only the first value of
the list is used for comparison unless the operator is IN_LIST
.
If IN_LIST
operator, then the entire list is used to filter the
dimensions as explained in the description of the IN_LIST
operator.
Corresponds to the JSON property expressions
278 279 280 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 278 def expressions @expressions end |
#not ⇒ Boolean Also known as: not?
Logical NOT
operator. If this boolean is set to true, then the matching
dimension values will be excluded in the report. The default is false.
Corresponds to the JSON property not
284 285 286 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 284 def not @not end |
#operator ⇒ String
How to match the dimension to the expression. The default is REGEXP.
Corresponds to the JSON property operator
290 291 292 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 290 def operator @operator end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
297 298 299 300 301 302 303 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 297 def update!(**args) @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @expressions = args[:expressions] if args.key?(:expressions) @not = args[:not] if args.key?(:not) @operator = args[:operator] if args.key?(:operator) end |