Class: Google::Cloud::SecurityCenter::V1::MuteConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/securitycenter/v1/mute_config.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 Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



76
77
78
79
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 76

class MuteConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns A description of the mute config.

Returns:

  • (::String) —

    A description of the mute config.



76
77
78
79
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 76

class MuteConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The human readable name to be displayed for the mute config.

Returns:

  • (::String) —

    The human readable name to be displayed for the mute config.



76
77
78
79
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 76

class MuteConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter ⇒ ::String

Returns 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: =, :.

Returns:

  • (::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: =, :


76
77
78
79
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 76

class MuteConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#most_recent_editor ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::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.



76
77
78
79
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 76

class MuteConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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}".

Returns:

  • (::String) —

    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}"



76
77
78
79
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 76

class MuteConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



76
77
78
79
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 76

class MuteConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end