Class: Google::Apis::SecuritycenterV1beta2::GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule

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

Overview

An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics 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 enablementState property in EffectiveSecurityHealthAnalyticsCustomModule 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. EffectiveSecurityHealthAnalyticsCustomModule is read-only.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule

Returns a new instance of GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule.



1932
1933
1934
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1932

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

Instance Attribute Details

#custom_config ⇒ Google::Apis::SecuritycenterV1beta2::GoogleCloudSecuritycenterV1CustomConfig

Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. Corresponds to the JSON property customConfig

Returns:



1907
1908
1909
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1907

def custom_config
  @custom_config
end

#display_name ⇒ String

Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. Corresponds to the JSON property displayName

Returns:

  • (String) 


1914
1915
1916
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1914

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) 


1920
1921
1922
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1920

def enablement_state
  @enablement_state
end

#name ⇒ String

Output only. The resource name of the custom module. Its format is " organizations/organization/securityHealthAnalyticsSettings/ effectiveCustomModules/customModule", or "folders/folder/ securityHealthAnalyticsSettings/effectiveCustomModules/customModule", or " projects/project/securityHealthAnalyticsSettings/effectiveCustomModules/ customModule" Corresponds to the JSON property name

Returns:

  • (String) 


1930
1931
1932
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1930

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1937
1938
1939
1940
1941
1942
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 1937

def update!(**args)
  @custom_config = args[:custom_config] if args.key?(:custom_config)
  @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)
end