Class: Google::Apis::AnalyticsV3::ProfileFilterLink

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 profile filter link.

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) ⇒ ProfileFilterLink

Returns a new instance of ProfileFilterLink



4139
4140
4141
# File 'generated/google/apis/analytics_v3/classes.rb', line 4139

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

Instance Attribute Details

#filter_refGoogle::Apis::AnalyticsV3::FilterRef

JSON template for a profile filter link. Corresponds to the JSON property filterRef



4102
4103
4104
# File 'generated/google/apis/analytics_v3/classes.rb', line 4102

def filter_ref
  @filter_ref
end

#idString

Profile filter link ID. Corresponds to the JSON property id

Returns:

  • (String)


4107
4108
4109
# File 'generated/google/apis/analytics_v3/classes.rb', line 4107

def id
  @id
end

#kindString

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

Returns:

  • (String)


4112
4113
4114
# File 'generated/google/apis/analytics_v3/classes.rb', line 4112

def kind
  @kind
end

#profile_refGoogle::Apis::AnalyticsV3::ProfileRef

JSON template for a linked view (profile). Corresponds to the JSON property profileRef



4117
4118
4119
# File 'generated/google/apis/analytics_v3/classes.rb', line 4117

def profile_ref
  @profile_ref
end

#rankFixnum

The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1. Corresponds to the JSON property rank

Returns:

  • (Fixnum)


4132
4133
4134
# File 'generated/google/apis/analytics_v3/classes.rb', line 4132

def rank
  @rank
end

Link for this profile filter link. Corresponds to the JSON property selfLink

Returns:

  • (String)


4137
4138
4139
# File 'generated/google/apis/analytics_v3/classes.rb', line 4137

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4144
4145
4146
4147
4148
4149
4150
4151
# File 'generated/google/apis/analytics_v3/classes.rb', line 4144

def update!(**args)
  @filter_ref = args[:filter_ref] if args.key?(:filter_ref)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @profile_ref = args[:profile_ref] if args.key?(:profile_ref)
  @rank = args[:rank] if args.key?(:rank)
  @self_link = args[:self_link] if args.key?(:self_link)
end