Class: Google::Apis::AnalyticsdataV1alpha::Filter

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

Overview

An expression to filter dimension or metric values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Filter

Returns a new instance of Filter.



626
627
628
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 626

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

Instance Attribute Details

#between_filter ⇒ Google::Apis::AnalyticsdataV1alpha::BetweenFilter

To express that the result needs to be between two numbers (inclusive). Corresponds to the JSON property betweenFilter

Returns:



594
595
596
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 594

def between_filter
  @between_filter
end

#field_name ⇒ String

The dimension name or metric name. Must be a name defined in dimensions or metrics. Corresponds to the JSON property fieldName

Returns:

  • (String) 


600
601
602
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 600

def field_name
  @field_name
end

#in_list_filter ⇒ Google::Apis::AnalyticsdataV1alpha::InListFilter

The result needs to be in a list of string values. Corresponds to the JSON property inListFilter

Returns:



605
606
607
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 605

def in_list_filter
  @in_list_filter
end

#null_filter ⇒ Boolean Also known as: null_filter?

A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null. Corresponds to the JSON property nullFilter

Returns:

  • (Boolean) 


613
614
615
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 613

def null_filter
  @null_filter
end

#numeric_filter ⇒ Google::Apis::AnalyticsdataV1alpha::NumericFilter

Filters for numeric or date values. Corresponds to the JSON property numericFilter

Returns:



619
620
621
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 619

def numeric_filter
  @numeric_filter
end

#string_filter ⇒ Google::Apis::AnalyticsdataV1alpha::StringFilter

The filter for string Corresponds to the JSON property stringFilter

Returns:



624
625
626
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 624

def string_filter
  @string_filter
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



631
632
633
634
635
636
637
638
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 631

def update!(**args)
  @between_filter = args[:between_filter] if args.key?(:between_filter)
  @field_name = args[:field_name] if args.key?(:field_name)
  @in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
  @null_filter = args[:null_filter] if args.key?(:null_filter)
  @numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
  @string_filter = args[:string_filter] if args.key?(:string_filter)
end