Class: Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV2MuteConfig

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

A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudSecuritycenterV2MuteConfig

Returns a new instance of GoogleCloudSecuritycenterV2MuteConfig.



6183
6184
6185
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6183

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. Corresponds to the JSON property createTime

Returns:

  • (String) 


6131
6132
6133
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6131

def create_time
  @create_time
end

#description ⇒ String

A description of the mute config. Corresponds to the JSON property description

Returns:

  • (String) 


6136
6137
6138
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6136

def description
  @description
end

#filter ⇒ String

Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: =, : * category: =, : * resource.name: =, : * resource. project_name: =, : * resource.project_display_name: =, : * resource. folders.resource_folder: =, : * resource.parent_name: =, : * resource. parent_display_name: =, : * resource.type: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, : Corresponds to the JSON property filter

Returns:

  • (String) 


6150
6151
6152
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6150

def filter
  @filter
end

#most_recent_editor ⇒ String

Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. Corresponds to the JSON property mostRecentEditor

Returns:

  • (String) 


6157
6158
6159
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6157

def most_recent_editor
  @most_recent_editor
end

#name ⇒ String

This field will be ignored if provided on config creation. The following list shows some examples of the format: + organizations/organization/muteConfigs/ mute_config+ `organizations/`organization`locations/`location`// muteConfigs/`mute_config + folders/folder/muteConfigs/mute_config+ ` folders/`folder`/locations/`location`/muteConfigs/`mute_config + projects/ project/muteConfigs/mute_config+ `projects/`project`/locations/`location`/ muteConfigs/`mute_config Corresponds to the JSON property name

Returns:

  • (String) 


6168
6169
6170
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6168

def name
  @name
end

#type ⇒ String

Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation. Corresponds to the JSON property type

Returns:

  • (String) 


6174
6175
6176
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6174

def type
  @type
end

#update_time ⇒ String

Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. Corresponds to the JSON property updateTime

Returns:

  • (String) 


6181
6182
6183
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6181

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6188
6189
6190
6191
6192
6193
6194
6195
6196
 
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 6188

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @filter = args[:filter] if args.key?(:filter)
  @most_recent_editor = args[:most_recent_editor] if args.key?(:most_recent_editor)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
end