Class: Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV2MuteConfig

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

Returns a new instance of GoogleCloudSecuritycenterV2MuteConfig.



5219
5220
5221
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5219

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)


5167
5168
5169
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5167

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


5172
5173
5174
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5172

def description
  @description
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)


5186
5187
5188
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5186

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)


5193
5194
5195
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5193

def most_recent_editor
  @most_recent_editor
end

#nameString

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)


5204
5205
5206
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5204

def name
  @name
end

#typeString

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)


5210
5211
5212
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5210

def type
  @type
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)


5217
5218
5219
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5217

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'lib/google/apis/securitycenter_v1beta1/classes.rb', line 5224

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