Security Command Center V2 API - Class Google::Cloud::SecurityCenter::V2::MuteConfig (v0.2.0)

Reference documentation and code samples for the Security Command Center V2 API class Google::Cloud::SecurityCenter::V2::MuteConfig.

A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.

Inherits

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
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.

#description

def description() -> ::String
Returns
  • (::String) — A description of the mute config.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A description of the mute config.
Returns
  • (::String) — A description of the mute config.

#filter

def filter() -> ::String
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: =, :

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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: =, :
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: =, :

#most_recent_editor

def most_recent_editor() -> ::String
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.

#name

def name() -> ::String
Returns
  • (::String) —

    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}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) —

    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}
Returns
  • (::String) —

    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}

#type

def type() -> ::Google::Cloud::SecurityCenter::V2::MuteConfig::MuteConfigType
Returns

#type=

def type=(value) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig::MuteConfigType
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
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.