Stackdriver Monitoring V3 Client - Class DeleteGroupRequest (1.6.0)

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
NameDescription
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
TypeDescription
string

setName

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

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

static::build

Parameter
NameDescription
name string

Required. The group to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Please see Google\Cloud\Monitoring\V3\GroupServiceClient::groupName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\DeleteGroupRequest