Class: Google::Cloud::SecurityCenter::V2::BulkMuteFindingsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/securitycenter/v2/securitycenter_service.rb

Overview

Request message for bulk findings update.

Note:

  1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined.
  2. Once a bulk operation is started, there is no way to stop it.

Defined Under Namespace

Modules: MuteState

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource.

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

Returns:

  • (::String) —

    Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

    Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource.

    The supported operators are:

    • = for all value types.
    • >, <, >=, <= for integer values.
    • :, meaning substring matching, for strings.

    The supported value types are:

    • string literals in quotes.
    • integer literals without quotes.
    • boolean literals true and false without quotes.


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/securitycenter/v2/securitycenter_service.rb', line 92

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

  # The mute state.
  module MuteState
    # Unused.
    MUTE_STATE_UNSPECIFIED = 0

    # Matching findings will be muted (default).
    MUTED = 1

    # Matching findings will have their mute state cleared.
    UNDEFINED = 2
  end
end

#mute_state ⇒ ::Google::Cloud::SecurityCenter::V2::BulkMuteFindingsRequest::MuteState

Returns Optional. All findings matching the given filter will have their mute state set to this value. The default value is MUTED. Setting this to UNDEFINED will clear the mute state on all matching findings.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/securitycenter/v2/securitycenter_service.rb', line 92

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

  # The mute state.
  module MuteState
    # Unused.
    MUTE_STATE_UNSPECIFIED = 0

    # Matching findings will be muted (default).
    MUTED = 1

    # Matching findings will have their mute state cleared.
    UNDEFINED = 2
  end
end

#parent ⇒ ::String

Returns Required. The parent, at which bulk action needs to be applied. If no location is specified, findings are updated in global. The following list shows some examples:

  • organizations/[organization_id]
  • organizations/[organization_id]/locations/[location_id]
  • folders/[folder_id]
  • folders/[folder_id]/locations/[location_id]
  • projects/[project_id]
  • projects/[project_id]/locations/[location_id].

Returns:

  • (::String) —

    Required. The parent, at which bulk action needs to be applied. If no location is specified, findings are updated in global. The following list shows some examples:

    • organizations/[organization_id]
    • organizations/[organization_id]/locations/[location_id]
    • folders/[folder_id]
    • folders/[folder_id]/locations/[location_id]
    • projects/[project_id]
    • projects/[project_id]/locations/[location_id]


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/securitycenter/v2/securitycenter_service.rb', line 92

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

  # The mute state.
  module MuteState
    # Unused.
    MUTE_STATE_UNSPECIFIED = 0

    # Matching findings will be muted (default).
    MUTED = 1

    # Matching findings will have their mute state cleared.
    UNDEFINED = 2
  end
end