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.

Defined Under Namespace

Modules: MuteConfigType

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.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
end

#description ⇒ ::String

Returns A description of the mute config.

Returns:

  • (::String) —

    A description of the mute config.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
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.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
end

#expiry_time ⇒ ::Google::Protobuf::Timestamp

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
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: =, :


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
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.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
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} 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}



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
end

#type ⇒ ::Google::Cloud::SecurityCenter::V1::MuteConfig::MuteConfigType

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
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.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'proto_docs/google/cloud/securitycenter/v1/mute_config.rb', line 90

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

  # The type of MuteConfig.
  module MuteConfigType
    # Unused.
    MUTE_CONFIG_TYPE_UNSPECIFIED = 0

    # A static mute config, which sets the static mute state of future matching
    # findings to muted. Once the static mute state has been set, finding or
    # config modifications will not affect the state.
    STATIC = 1

    # A dynamic mute config, which is applied to existing and future matching
    # findings, setting their dynamic mute state to "muted". If the config is
    # updated or deleted, or a matching finding is updated, such that the
    # finding doesn't match the config, the config will be removed from the
    # finding, and the finding's dynamic mute state may become "unmuted"
    # (unless other configs still match).
    DYNAMIC = 2
  end
end