Reference documentation and code samples for the Google Cloud Security Command Center V1 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.v1.MuteConfig
Namespace
Google \ Cloud \ SecurityCenter \ V1Methods
__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. Format |
↳ display_name |
string
The human readable name to be displayed for the 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: |
↳ 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
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. |
↳ expiry_time |
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. |
getName
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 | |
|---|---|
| Type | Description |
string |
|
setName
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
The human readable name to be displayed for the mute config.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
The human readable name to be displayed for the 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
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 | |
|---|---|
| Type | Description |
int |
|
setType
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpiryTime
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpiryTime
clearExpiryTime
setExpiryTime
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|