Class: Google::Apis::SecuritycenterV1::EffectiveEventThreatDetectionCustomModule

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

Overview

An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the enablement_state property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of INHERITED. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also enabled. EffectiveEventThreatDetectionCustomModule is read-only.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EffectiveEventThreatDetectionCustomModule

Returns a new instance of EffectiveEventThreatDetectionCustomModule.



1520
1521
1522
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1520

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

Instance Attribute Details

#config ⇒ Hash<String,Object>

Output only. Config for the effective module. Corresponds to the JSON property config

Returns:



1488
1489
1490
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1488

def config
  @config
end

#description ⇒ String

Output only. The description for the module. Corresponds to the JSON property description

Returns:

  • (String) 


1493
1494
1495
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1493

def description
  @description
end

#display_name ⇒ String

Output only. The human readable name to be displayed for the module. Corresponds to the JSON property displayName

Returns:

  • (String) 


1498
1499
1500
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1498

def display_name
  @display_name
end

#enablement_state ⇒ String

Output only. The effective state of enablement for the module at the given level of the hierarchy. Corresponds to the JSON property enablementState

Returns:

  • (String) 


1504
1505
1506
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1504

def enablement_state
  @enablement_state
end

#name ⇒ String

Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/organization/eventThreatDetectionSettings/ effectiveCustomModules/module". * "folders/folder/ eventThreatDetectionSettings/effectiveCustomModules/module". * "projects/ project/eventThreatDetectionSettings/effectiveCustomModules/module". Corresponds to the JSON property name

Returns:

  • (String) 


1513
1514
1515
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1513

def name
  @name
end

#type ⇒ String

Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. Corresponds to the JSON property type

Returns:

  • (String) 


1518
1519
1520
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1518

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1525

def update!(**args)
  @config = args[:config] if args.key?(:config)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enablement_state = args[:enablement_state] if args.key?(:enablement_state)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
end