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.


3948
3949
3950
# File 'generated/google/apis/analytics_v3/classes.rb', line 3948

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


3911
3912
3913
# File 'generated/google/apis/analytics_v3/classes.rb', line 3911

def filter_ref
  @filter_ref
end

#idString

Profile filter link ID. Corresponds to the JSON property id

Returns:

  • (String)

3916
3917
3918
# File 'generated/google/apis/analytics_v3/classes.rb', line 3916

def id
  @id
end

#kindString

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

Returns:

  • (String)

3921
3922
3923
# File 'generated/google/apis/analytics_v3/classes.rb', line 3921

def kind
  @kind
end

#profile_refGoogle::Apis::AnalyticsV3::ProfileRef

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


3926
3927
3928
# File 'generated/google/apis/analytics_v3/classes.rb', line 3926

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)

3941
3942
3943
# File 'generated/google/apis/analytics_v3/classes.rb', line 3941

def rank
  @rank
end

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

Returns:

  • (String)

3946
3947
3948
# File 'generated/google/apis/analytics_v3/classes.rb', line 3946

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3953
3954
3955
3956
3957
3958
3959
3960
# File 'generated/google/apis/analytics_v3/classes.rb', line 3953

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