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.



1787
1788
1789
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1787

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)


1740
1741
1742
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1740

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


1745
1746
1747
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1745

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)


1750
1751
1752
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1750

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)


1764
1765
1766
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1764

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)


1771
1772
1773
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1771

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)


1778
1779
1780
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1778

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)


1785
1786
1787
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1785

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1792
1793
1794
1795
1796
1797
1798
1799
1800
# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1792

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