Class: Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1CustomConfig

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

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudSecuritycenterV1CustomConfig

Returns a new instance of GoogleCloudSecuritycenterV1CustomConfig.



3150
3151
3152
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3150

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

Instance Attribute Details

#custom_output ⇒ Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1CustomOutputSpec

A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under sourceProperties. Corresponds to the JSON property customOutput

Returns:



3104
3105
3106
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3104

def custom_output
  @custom_output
end

#description ⇒ String

Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. Corresponds to the JSON property description

Returns:

  • (String) 


3112
3113
3114
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3112

def description
  @description
end

#predicate ⇒ Google::Apis::SecuritycenterV1::Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: " Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example ( Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. Corresponds to the JSON property predicate

Returns:



3131
3132
3133
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3131

def predicate
  @predicate
end

#recommendation ⇒ String

An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps property of the finding JSON. Corresponds to the JSON property recommendation

Returns:

  • (String) 


3138
3139
3140
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3138

def recommendation
  @recommendation
end

#resource_selector ⇒ Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1ResourceSelector

Resource for selecting resource type. Corresponds to the JSON property resourceSelector

Returns:



3143
3144
3145
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3143

def resource_selector
  @resource_selector
end

#severity ⇒ String

The severity to assign to findings generated by the module. Corresponds to the JSON property severity

Returns:

  • (String) 


3148
3149
3150
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3148

def severity
  @severity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3155
3156
3157
3158
3159
3160
3161
3162
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 3155

def update!(**args)
  @custom_output = args[:custom_output] if args.key?(:custom_output)
  @description = args[:description] if args.key?(:description)
  @predicate = args[:predicate] if args.key?(:predicate)
  @recommendation = args[:recommendation] if args.key?(:recommendation)
  @resource_selector = args[:resource_selector] if args.key?(:resource_selector)
  @severity = args[:severity] if args.key?(:severity)
end