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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Filter

Returns a new instance of Filter



2128
2129
2130
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2128

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) 


2054
2055
2056
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2054

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:



2059
2060
2061
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2059

def advanced_details
  @advanced_details
end

#created ⇒ DateTime

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

Returns:

  • (DateTime) 


2064
2065
2066
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2064

def created
  @created
end

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

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

Returns:



2069
2070
2071
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2069

def exclude_details
  @exclude_details
end

#id ⇒ String

Filter ID. Corresponds to the JSON property id

Returns:

  • (String) 


2074
2075
2076
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2074

def id
  @id
end

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

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

Returns:



2079
2080
2081
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2079

def include_details
  @include_details
end

#kind ⇒ String

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

Returns:

  • (String) 


2084
2085
2086
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2084

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:



2089
2090
2091
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2089

def lowercase_details
  @lowercase_details
end

#name ⇒ String

Name of this filter. Corresponds to the JSON property name

Returns:

  • (String) 


2094
2095
2096
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2094

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:



2100
2101
2102
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2100

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:



2105
2106
2107
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2105

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) 


2110
2111
2112
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2110

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) 


2116
2117
2118
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2116

def type
  @type
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


2121
2122
2123
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2121

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:



2126
2127
2128
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2126

def uppercase_details
  @uppercase_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2133

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