Cloud Security Command Center V1 API - Class Google::Cloud::SecurityCenter::V1::MuteConfig (v1.1.0)

Version 1.1.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.2
• 0.33.0
• 0.32.0
• 0.31.1
• 0.30.0
• 0.29.1
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.1
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.1
• 0.11.1

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

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

Inherits

• Object

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.

#display_name

def display_name() -> ::String

Returns

• (::String) — The human readable name to be displayed for the mute config.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — The human readable name to be displayed for the mute config.

Returns

• (::String) — The human readable name to be displayed for the mute config.

#expiry_time

def expiry_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.

#expiry_time=

def expiry_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.

Returns

• (::Google::Protobuf::Timestamp) — Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.

#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. 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}

#name=

def name=(value) -> ::String

Parameter

• value (::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} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/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} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}

#type

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

Returns

• (::Google::Cloud::SecurityCenter::V1::MuteConfig::MuteConfigType) — Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.

#type=

def type=(value) -> ::Google::Cloud::SecurityCenter::V1::MuteConfig::MuteConfigType

Parameter

• value (::Google::Cloud::SecurityCenter::V1::MuteConfig::MuteConfigType) — Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.

Returns

• (::Google::Cloud::SecurityCenter::V1::MuteConfig::MuteConfigType) — Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.

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