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- (::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- (::String) — A description of the mute config.
#description=
def description=(value) -> ::String- value (::String) — A description of the mute config.
- (::String) — A description of the mute config.
#expiry_time
def expiry_time() -> ::Google::Protobuf::Timestamp- (::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- 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.
- (::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-
(::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:
=,:
- severity:
#filter=
def filter=(value) -> ::String-
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:
=,:
- severity:
-
(::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:
=,:
- severity:
#most_recent_editor
def most_recent_editor() -> ::String- (::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-
(::String) —
Identifier. 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-
value (::String) —
Identifier. 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}
-
(::String) —
Identifier. 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- (::Google::Cloud::SecurityCenter::V2::MuteConfig::MuteConfigType) — Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.
#type=
def type=(value) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig::MuteConfigType- value (::Google::Cloud::SecurityCenter::V2::MuteConfig::MuteConfigType) — Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.
- (::Google::Cloud::SecurityCenter::V2::MuteConfig::MuteConfigType) — Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp- (::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.