Google Cloud Security Command Center V1 Client - Class ListMuteConfigsRequest (1.13.1)

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

Request message for listing mute configs at a given scope e.g. organization, folder or project.

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

Methods

__construct

Constructor.

Parameters
NameDescription
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]".

↳ 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]".

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field int32 page_size = 2;

Returns
TypeDescription
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.

Generated from protobuf field int32 page_size = 2;

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Generated from protobuf field string page_token = 3;

Returns
TypeDescription
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.

Generated from protobuf field string page_token = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this