Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Computeaccounts_Groups_Resource Class Reference

The "groups" collection of methods. More...

Inheritance diagram for Google_Service_Computeaccounts_Groups_Resource:
Google_Service_Resource

Public Member Functions

 addMember ($project, $groupName, Google_Service_Computeaccounts_GroupsAddMemberRequest $postBody, $optParams=array())
 Adds users to the specified group.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($project, $groupName, $optParams=array())
 Deletes the specified group resource.
 
 get ($project, $groupName, $optParams=array())
 Returns the specified group resource.
 
 insert ($project, Google_Service_Computeaccounts_Group $postBody, $optParams=array())
 Creates a group resource in the specified project using the data included in the request.
 
 listGroups ($project, $optParams=array())
 Retrieves the list of groups contained within the specified project.
 
 removeMember ($project, $groupName, Google_Service_Computeaccounts_GroupsRemoveMemberRequest $postBody, $optParams=array())
 Removes users from the specified group.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "groups" collection of methods.

Typical usage is: $computeaccountsService = new Google_Service_Computeaccounts(...); $groups = $computeaccountsService->groups;

Member Function Documentation

◆ addMember()

Google_Service_Computeaccounts_Groups_Resource::addMember ( $project,
$groupName,
Google_Service_Computeaccounts_GroupsAddMemberRequest $postBody,
$optParams = array() )

Adds users to the specified group.

(groups.addMember)

Parameters
string$projectProject ID for this request.
string$groupNameName of the group for this request.
Google_GroupsAddMemberRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Computeaccounts_Groups_Resource::delete ( $project,
$groupName,
$optParams = array() )

Deletes the specified group resource.

(groups.delete)

Parameters
string$projectProject ID for this request.
string$groupNameName of the group resource to delete.
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

◆ get()

Google_Service_Computeaccounts_Groups_Resource::get ( $project,
$groupName,
$optParams = array() )

Returns the specified group resource.

(groups.get)

Parameters
string$projectProject ID for this request.
string$groupNameName of the group resource to return.
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Group

◆ insert()

Google_Service_Computeaccounts_Groups_Resource::insert ( $project,
Google_Service_Computeaccounts_Group $postBody,
$optParams = array() )

Creates a group resource in the specified project using the data included in the request.

(groups.insert)

Parameters
string$projectProject ID for this request.
Google_Group$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

◆ listGroups()

Google_Service_Computeaccounts_Groups_Resource::listGroups ( $project,
$optParams = array() )

Retrieves the list of groups contained within the specified project.

(groups.listGroups)

Parameters
string$projectProject ID for this request.
array$optParamsOptional parameters.

@opt_param string filter Optional. Filter expression for filtering listed resources. @opt_param string pageToken Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. @opt_param string maxResults Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

Return values
Google_Service_Computeaccounts_GroupList

◆ removeMember()

Google_Service_Computeaccounts_Groups_Resource::removeMember ( $project,
$groupName,
Google_Service_Computeaccounts_GroupsRemoveMemberRequest $postBody,
$optParams = array() )

Removes users from the specified group.

(groups.removeMember)

Parameters
string$projectProject ID for this request.
string$groupNameName of the group for this request.
Google_GroupsRemoveMemberRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

The documentation for this class was generated from the following file: