Class: Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1MuteConfig

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) ⇒ GoogleCloudSecuritycenterV1MuteConfig

Returns a new instance of GoogleCloudSecuritycenterV1MuteConfig.



1357
1358
1359
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1357

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

Instance Attribute Details

#create_timeString

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)


1310
1311
1312
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1310

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


1315
1316
1317
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1315

def description
  @description
end

#display_nameString

The human readable name to be displayed for the mute config. Corresponds to the JSON property displayName

Returns:

  • (String)


1320
1321
1322
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1320

def display_name
  @display_name
end

#filterString

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)


1334
1335
1336
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1334

def filter
  @filter
end

#most_recent_editorString

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)


1341
1342
1343
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1341

def most_recent_editor
  @most_recent_editor
end

#nameString

This field will be ignored if provided on config creation. Format " organizations/organization/muteConfigs/mute_config" "folders/folder/ muteConfigs/mute_config" "projects/project/muteConfigs/mute_config" Corresponds to the JSON property name

Returns:

  • (String)


1348
1349
1350
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1348

def name
  @name
end

#update_timeString

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)


1355
1356
1357
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1355

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1362
1363
1364
1365
1366
1367
1368
1369
1370
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1362

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