1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Monitoring
  7. \
  8. Resource
  9. \
  10. ProjectsGroups

ProjectsGroups

class ProjectsGroups extends Resource (View source)

The "groups" collection of methods.

Typical usage is:

 $monitoringService = new Google\Service\Monitoring(...);
 $groups = $monitoringService->projects_groups;

Methods

Group
create(string $name, Group $postBody, array $optParams = [])

Creates a new group. (groups.create)

MonitoringEmpty
delete(string $name, array $optParams = [])

Deletes an existing group. (groups.delete)

Group
get(string $name, array $optParams = [])

Gets a single group. (groups.get)

ListGroupsResponse
listProjectsGroups(string $name, array $optParams = [])

Lists the existing groups. (groups.listProjectsGroups)

Group
update(string $name, Group $postBody, array $optParams = [])

Updates an existing group. You can change any group attributes except name.

Details

at line 48
Group create(string $name, Group $postBody, array $optParams = [])

Creates a new group. (groups.create)

Parameters

string $name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER]
Group $postBody
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception

at line 67
MonitoringEmpty delete(string $name, array $optParams = [])

Deletes an existing group. (groups.delete)

Parameters

string $name

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

Optional parameters.

Return Value

MonitoringEmpty

Exceptions

Exception

at line 82
Group get(string $name, array $optParams = [])

Gets a single group. (groups.get)

Parameters

string $name

Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception

at line 118
ListGroupsResponse listProjectsGroups(string $name, array $optParams = [])

Lists the existing groups. (groups.listProjectsGroups)

Parameters

string $name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
array $optParams

Optional parameters.

Return Value

ListGroupsResponse

Exceptions

Exception

at line 141
Group update(string $name, Group $postBody, array $optParams = [])

Updates an existing group. You can change any group attributes except name.

(groups.update)

Parameters

string $name

Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.
Group $postBody
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception