Google Cloud Security Command Center V1 Client - Class BulkMuteFindingsRequest (2.0.2)

Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class BulkMuteFindingsRequest.

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.

Generated from protobuf message google.cloud.securitycenter.v1.BulkMuteFindingsRequest

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent, at which bulk action needs to be applied. Its format is organizations/[organization_id], folders/[folder_id], projects/[project_id].
↳ filter 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.
↳ mute_annotation string

This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.
↳ mute_state int

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.

getParent

Required. The parent, at which bulk action needs to be applied. Its format is organizations/[organization_id], folders/[folder_id], projects/[project_id].

Returns
Type Description
string

setParent

Required. The parent, at which bulk action needs to be applied. Its format is organizations/[organization_id], folders/[folder_id], projects/[project_id].

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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
Type Description
string

setFilter

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getMuteAnnotation

This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.

Returns
Type Description
string

setMuteAnnotation

This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.

Parameter
Name Description
var string
Returns
Type Description
$this

getMuteState

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
Type Description
int

setMuteState

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.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, at which bulk action needs to be applied. Its format is organizations/[organization_id], folders/[folder_id], projects/[project_id].
Returns
Type Description
BulkMuteFindingsRequest