Class: Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoLogSettings

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

Overview

The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/ integration-platform/analytics/logging_task.md for details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmEventbusProtoLogSettings

Returns a new instance of EnterpriseCrmEventbusProtoLogSettings.



1615
1616
1617
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 1615

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

Instance Attribute Details

#log_field_name ⇒ String

The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. Corresponds to the JSON property logFieldName

Returns:

  • (String) 


1588
1589
1590
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 1588

def log_field_name
  @log_field_name
end

#sanitize_options ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmLoggingGwsSanitizeOptions

Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 Corresponds to the JSON property sanitizeOptions

Returns:



1597
1598
1599
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 1597

def sanitize_options
  @sanitize_options
end

#seed_period ⇒ String

Corresponds to the JSON property seedPeriod

Returns:

  • (String) 


1602
1603
1604
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 1602

def seed_period
  @seed_period
end

#seed_scope ⇒ String

Corresponds to the JSON property seedScope

Returns:

  • (String) 


1607
1608
1609
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 1607

def seed_scope
  @seed_scope
end

#shortening_limits ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmLoggingGwsFieldLimits

Describes string and array limits when writing to logs. When a limit is exceeded the shortener_type describes how to shorten the field. next_id: 6 Corresponds to the JSON property shorteningLimits

Returns:



1613
1614
1615
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 1613

def shortening_limits
  @shortening_limits
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 1620

def update!(**args)
  @log_field_name = args[:log_field_name] if args.key?(:log_field_name)
  @sanitize_options = args[:sanitize_options] if args.key?(:sanitize_options)
  @seed_period = args[:seed_period] if args.key?(:seed_period)
  @seed_scope = args[:seed_scope] if args.key?(:seed_scope)
  @shortening_limits = args[:shortening_limits] if args.key?(:shortening_limits)
end