Class: Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1MuteConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/securitycenter_v1beta1/classes.rb,
lib/google/apis/securitycenter_v1beta1/representations.rb,
lib/google/apis/securitycenter_v1beta1/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.



2620
2621
2622
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2620

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)


2570
2571
2572
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2570

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


2575
2576
2577
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2575

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)


2580
2581
2582
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2580

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)


2594
2595
2596
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2594

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)


2601
2602
2603
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2601

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" " organizations/organization/locations/global/muteConfigs/mute_config" " folders/folder/locations/global/muteConfigs/mute_config" "projects/ project/locations/global/muteConfigs/mute_config" Corresponds to the JSON property name

Returns:

  • (String)


2611
2612
2613
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2611

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)


2618
2619
2620
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2618

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2625
2626
2627
2628
2629
2630
2631
2632
2633
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 2625

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