Google Cloud Security Command Center V2 Client - Class GetMuteConfigRequest (2.0.0-RC1)

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

Request message for retrieving a mute config. If no location is specified, default is global.

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

Namespace

Google \ Cloud \ SecurityCenter \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the mute config to retrieve. The following list shows some examples of the format: + organizations/{organization}/muteConfigs/{config_id} + organizations/{organization}/locations/{location}/muteConfigs/{config_id} + folders/{folder}/muteConfigs/{config_id} + folders/{folder}/locations/{location}/muteConfigs/{config_id} + projects/{project}/muteConfigs/{config_id} + projects/{project}/locations/{location}/muteConfigs/{config_id}

getName

Required. Name of the mute config to retrieve. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{config_id} + organizations/{organization}/locations/{location}/muteConfigs/{config_id}
  • folders/{folder}/muteConfigs/{config_id}
  • folders/{folder}/locations/{location}/muteConfigs/{config_id}
  • projects/{project}/muteConfigs/{config_id}
  • projects/{project}/locations/{location}/muteConfigs/{config_id}
Returns
Type Description
string

setName

Required. Name of the mute config to retrieve. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{config_id} + organizations/{organization}/locations/{location}/muteConfigs/{config_id}
  • folders/{folder}/muteConfigs/{config_id}
  • folders/{folder}/locations/{location}/muteConfigs/{config_id}
  • projects/{project}/muteConfigs/{config_id}
  • projects/{project}/locations/{location}/muteConfigs/{config_id}
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Name of the mute config to retrieve. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{config_id} + organizations/{organization}/locations/{location}/muteConfigs/{config_id}
  • folders/{folder}/muteConfigs/{config_id}
  • folders/{folder}/locations/{location}/muteConfigs/{config_id}
  • projects/{project}/muteConfigs/{config_id}
  • projects/{project}/locations/{location}/muteConfigs/{config_id} Please see Google\Cloud\SecurityCenter\V2\SecurityCenterClient::muteConfigName() for help formatting this field.
Returns
Type Description
Google\Cloud\SecurityCenter\V2\GetMuteConfigRequest