Documentation

Google_Service_Monitoring_Resource_ProjectsGroups extends Google_Service_Resource
in package

The "groups" collection of methods.

Typical usage is: $monitoringService = new Google_Service_Monitoring(...); $groups = $monitoringService->groups;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Monitoring_Group
Creates a new group. (groups.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Monitoring_MonitoringEmpty
Deletes an existing group. (groups.delete)
get()  : Google_Service_Monitoring_Group
Gets a single group. (groups.get)
listProjectsGroups()  : Google_Service_Monitoring_ListGroupsResponse
Lists the existing groups. (groups.listProjectsGroups)
update()  : Google_Service_Monitoring_Group
Updates an existing group. You can change any group attributes except name.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a new group. (groups.create)

public create(string $name, Google_Service_Monitoring_Group $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_Group
Parameters
$name : string

Required. The project in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER]

$postBody : Google_Service_Monitoring_Group
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool validateOnly If true, validate this request but do not create the group.

Return values
Google_Service_Monitoring_Group

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes an existing group. (groups.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_MonitoringEmpty
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool recursive 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.

Return values
Google_Service_Monitoring_MonitoringEmpty

get()

Gets a single group. (groups.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_Group
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Monitoring_Group

listProjectsGroups()

Lists the existing groups. (groups.listProjectsGroups)

public listProjectsGroups(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_ListGroupsResponse
Parameters
$name : string

Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string descendantsOfGroup A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.

opt_param

string childrenOfGroup A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.

opt_param

string ancestorsOfGroup A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

opt_param

int pageSize A positive number that is the maximum number of results to return.

opt_param

string pageToken If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Return values
Google_Service_Monitoring_ListGroupsResponse

update()

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

public update(string $name, Google_Service_Monitoring_Group $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_Group

(groups.update)

Parameters
$name : string

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.

$postBody : Google_Service_Monitoring_Group
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool validateOnly If true, validate this request but do not update the existing group.

Return values
Google_Service_Monitoring_Group

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results