Google Cloud Security Command Center V2 Client - Class ListMuteConfigsRequest (1.32.0)

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

Request message for listing mute configs at a given scope e.g. organization, folder or project. If no location is specified, default is global.

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

Namespace

Google \ Cloud \ SecurityCenter \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The parent, which owns the collection of mute configs. Its format is organizations/[organization_id]", "folders/[folder_id], projects/[project_id], organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], projects/[project_id]/locations/[location_id].
↳ page_size int

The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
↳ page_token string

A page token, received from a previous ListMuteConfigs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMuteConfigs must match the call that provided the page token.

getParent

Required. The parent, which owns the collection of mute configs. Its format is organizations/[organization_id]", "folders/[folder_id], projects/[project_id], organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], projects/[project_id]/locations/[location_id].

Returns
Type Description
string

setParent

Required. The parent, which owns the collection of mute configs. Its format is organizations/[organization_id]", "folders/[folder_id], projects/[project_id], organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], projects/[project_id]/locations/[location_id].

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of configs to return. The service may return fewer than this value.

If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

The maximum number of configs to return. The service may return fewer than this value.

If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous ListMuteConfigs call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMuteConfigs must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous ListMuteConfigs call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMuteConfigs must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, which owns the collection of mute configs. Its format is organizations/[organization_id]", "folders/[folder_id], projects/[project_id], organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], projects/[project_id]/locations/[location_id]. Please see Google\Cloud\SecurityCenter\V2\SecurityCenterClient::organizationLocationName() for help formatting this field.
Returns
Type Description
Google\Cloud\SecurityCenter\V2\ListMuteConfigsRequest