Stackdriver Monitoring V3 Client - Class DeleteGroupRequest (1.12.1)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class DeleteGroupRequest.

The DeleteGroup request. The default behavior is to be able to delete a single group without any descendants.

Generated from protobuf message google.monitoring.v3.DeleteGroupRequest

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
↳ recursive bool

If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.

getName

Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns
Type Description
string

setName

Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Parameter
Name Description
var string
Returns
Type Description
$this

getRecursive

If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.

Returns
Type Description
bool

setRecursive

If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The group to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Please see GroupServiceClient::groupName() for help formatting this field.
Returns
Type Description
DeleteGroupRequest