Google Cloud Security Command Center V2 Client - Class MuteConfig (1.28.2)

Reference documentation and code samples for the Google Cloud Security Command Center V2 Client class MuteConfig.

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

Generated from protobuf message google.cloud.securitycenter.v2.MuteConfig

Namespace

Google \ Cloud \ SecurityCenter \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

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}
↳ description string

A description of the mute config.
↳ filter 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: =, :
↳ create_time 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.
↳ update_time 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.
↳ most_recent_editor 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.
↳ type int

Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.

getName

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

setName

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

getDescription

A description of the mute config.

Returns
Type Description
string

setDescription

A description of the mute config.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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

setFilter

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

getCreateTime

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
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getMostRecentEditor

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

setMostRecentEditor

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.

Returns
Type Description
int

setType

Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.

Parameter
Name Description
var int
Returns
Type Description
$this