Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataRedactionSettings

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

Overview

Settings for client-side data redaction. Singleton resource under a Web Stream.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaDataRedactionSettings

Returns a new instance of GoogleAnalyticsAdminV1alphaDataRedactionSettings.



2553
2554
2555
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2553

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

Instance Attribute Details

#email_redaction_enabled ⇒ Boolean Also known as: email_redaction_enabled?

If enabled, any event parameter or user property values that look like an email will be redacted. Corresponds to the JSON property emailRedactionEnabled

Returns:

  • (Boolean) 


2526
2527
2528
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2526

def email_redaction_enabled
  @email_redaction_enabled
end

#name ⇒ String

Output only. Name of this Data Redaction Settings resource. Format: properties/ property_id/dataStreams/data_stream/dataRedactionSettings Example: " properties/1000/dataStreams/2000/dataRedactionSettings" Corresponds to the JSON property name

Returns:

  • (String) 


2534
2535
2536
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2534

def name
  @name
end

#query_parameter_keys ⇒ Array<String>

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas. Corresponds to the JSON property queryParameterKeys

Returns:

  • (Array<String>) 


2542
2543
2544
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2542

def query_parameter_keys
  @query_parameter_keys
end

#query_parameter_redaction_enabled ⇒ Boolean Also known as: query_parameter_redaction_enabled?

Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted. Corresponds to the JSON property queryParameterRedactionEnabled

Returns:

  • (Boolean) 


2550
2551
2552
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2550

def query_parameter_redaction_enabled
  @query_parameter_redaction_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2558
2559
2560
2561
2562
2563
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2558

def update!(**args)
  @email_redaction_enabled = args[:email_redaction_enabled] if args.key?(:email_redaction_enabled)
  @name = args[:name] if args.key?(:name)
  @query_parameter_keys = args[:query_parameter_keys] if args.key?(:query_parameter_keys)
  @query_parameter_redaction_enabled = args[:query_parameter_redaction_enabled] if args.key?(:query_parameter_redaction_enabled)
end