Class: Google::Apis::AnalyticsV3::Filter

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

Overview

JSON template for an Analytics account filter.

Defined Under Namespace

Classes: AdvancedDetails, LowercaseDetails, ParentLink, SearchAndReplaceDetails, UppercaseDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Filter

Returns a new instance of Filter.



2006
2007
2008
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2006

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

Instance Attribute Details

#account_id ⇒ String

Account ID to which this filter belongs. Corresponds to the JSON property accountId

Returns:

  • (String) 


1932
1933
1934
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1932

def 
  @account_id
end

#advanced_details ⇒ Google::Apis::AnalyticsV3::Filter::AdvancedDetails

Details for the filter of the type ADVANCED. Corresponds to the JSON property advancedDetails

Returns:



1937
1938
1939
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1937

def advanced_details
  @advanced_details
end

#created ⇒ DateTime

Time this filter was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


1942
1943
1944
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1942

def created
  @created
end

#exclude_details ⇒ Google::Apis::AnalyticsV3::FilterExpression

JSON template for an Analytics filter expression. Corresponds to the JSON property excludeDetails

Returns:



1947
1948
1949
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1947

def exclude_details
  @exclude_details
end

#id ⇒ String

Filter ID. Corresponds to the JSON property id

Returns:

  • (String) 


1952
1953
1954
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1952

def id
  @id
end

#include_details ⇒ Google::Apis::AnalyticsV3::FilterExpression

JSON template for an Analytics filter expression. Corresponds to the JSON property includeDetails

Returns:



1957
1958
1959
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1957

def include_details
  @include_details
end

#kind ⇒ String

Resource type for Analytics filter. Corresponds to the JSON property kind

Returns:

  • (String) 


1962
1963
1964
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1962

def kind
  @kind
end

#lowercase_details ⇒ Google::Apis::AnalyticsV3::Filter::LowercaseDetails

Details for the filter of the type LOWER. Corresponds to the JSON property lowercaseDetails

Returns:



1967
1968
1969
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1967

def lowercase_details
  @lowercase_details
end

#name ⇒ String

Name of this filter. Corresponds to the JSON property name

Returns:

  • (String) 


1972
1973
1974
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1972

def name
  @name
end

#parent_link ⇒ Google::Apis::AnalyticsV3::Filter::ParentLink

Parent link for this filter. Points to the account to which this filter belongs. Corresponds to the JSON property parentLink

Returns:



1978
1979
1980
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1978

def parent_link
  @parent_link
end

#search_and_replace_details ⇒ Google::Apis::AnalyticsV3::Filter::SearchAndReplaceDetails

Details for the filter of the type SEARCH_AND_REPLACE. Corresponds to the JSON property searchAndReplaceDetails

Returns:



1983
1984
1985
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1983

def search_and_replace_details
  @search_and_replace_details
end

#self_link ⇒ String

Link for this filter. Corresponds to the JSON property selfLink

Returns:

  • (String) 


1988
1989
1990
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1988

def self_link
  @self_link
end

#type ⇒ String

Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. Corresponds to the JSON property type

Returns:

  • (String) 


1994
1995
1996
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1994

def type
  @type
end

#updated ⇒ DateTime

Time this filter was last modified. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


1999
2000
2001
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1999

def updated
  @updated
end

#uppercase_details ⇒ Google::Apis::AnalyticsV3::Filter::UppercaseDetails

Details for the filter of the type UPPER. Corresponds to the JSON property uppercaseDetails

Returns:



2004
2005
2006
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2004

def uppercase_details
  @uppercase_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2011

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @advanced_details = args[:advanced_details] if args.key?(:advanced_details)
  @created = args[:created] if args.key?(:created)
  @exclude_details = args[:exclude_details] if args.key?(:exclude_details)
  @id = args[:id] if args.key?(:id)
  @include_details = args[:include_details] if args.key?(:include_details)
  @kind = args[:kind] if args.key?(:kind)
  @lowercase_details = args[:lowercase_details] if args.key?(:lowercase_details)
  @name = args[:name] if args.key?(:name)
  @parent_link = args[:parent_link] if args.key?(:parent_link)
  @search_and_replace_details = args[:search_and_replace_details] if args.key?(:search_and_replace_details)
  @self_link = args[:self_link] if args.key?(:self_link)
  @type = args[:type] if args.key?(:type)
  @updated = args[:updated] if args.key?(:updated)
  @uppercase_details = args[:uppercase_details] if args.key?(:uppercase_details)
end