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

Inheritance diagram for Google_Service_CloudUserAccounts_Groups_Resource:

Public Member Functions
	addMember ($project, $groupName, Google_Service_CloudUserAccounts_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.

	getIamPolicy ($project, $resource, $optParams=array())
	Gets the access control policy for a resource.

	insert ($project, Google_Service_CloudUserAccounts_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_CloudUserAccounts_GroupsRemoveMemberRequest $postBody, $optParams=array())
	Removes users from the specified group.

	setIamPolicy ($project, $resource, Google_Service_CloudUserAccounts_Policy $postBody, $optParams=array())
	Sets the access control policy on the specified resource.

	testIamPermissions ($project, $resource, Google_Service_CloudUserAccounts_TestPermissionsRequest $postBody, $optParams=array())
	Returns permissions that a caller has on the specified resource.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "groups" collection of methods.

Typical usage is: $clouduseraccountsService = new Google_Service_CloudUserAccounts(...); $groups = $clouduseraccountsService->groups;

Member Function Documentation

◆ addMember()

Google_Service_CloudUserAccounts_Groups_Resource::addMember	(		$project,
			$groupName,
		Google_Service_CloudUserAccounts_GroupsAddMemberRequest	$postBody,
			$optParams = array() )

Adds users to the specified group.

(groups.addMember)

Parameters

string	$project	Project ID for this request.
string	$groupName	Name of the group for this request.
Google_GroupsAddMemberRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_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_CloudUserAccounts_Groups_Resource::delete	(	$project,
		$groupName,
		$optParams = array() )

Deletes the specified Group resource.

(groups.delete)

Parameters

string	$project	Project ID for this request.
string	$groupName	Name of the Group resource to delete.
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_Operation

◆ get()

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

Returns the specified Group resource.

(groups.get)

Parameters

string	$project	Project ID for this request.
string	$groupName	Name of the Group resource to return.
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_Group

◆ getIamPolicy()

Google_Service_CloudUserAccounts_Groups_Resource::getIamPolicy	(	$project,
		$resource,
		$optParams = array() )

Gets the access control policy for a resource.

May be empty if no such policy or resource exists. (groups.getIamPolicy)

Parameters

string	$project	Project ID for this request.
string	$resource	Name of the resource for this request.
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_Policy

◆ insert()

Google_Service_CloudUserAccounts_Groups_Resource::insert	(		$project,
		Google_Service_CloudUserAccounts_Group	$postBody,
			$optParams = array() )

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

(groups.insert)

Parameters

string	$project	Project ID for this request.
Google_Group	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_Operation

◆ listGroups()

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

Retrieves the list of groups contained within the specified project.

(groups.listGroups)

Parameters

string	$project	Project ID for this request.
array	$optParams	Optional parameters.

@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance. @opt_param string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported. @opt_param string maxResults Maximum count of results to be returned. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.

Return values

Google_Service_CloudUserAccounts_GroupList

◆ removeMember()

Google_Service_CloudUserAccounts_Groups_Resource::removeMember	(		$project,
			$groupName,
		Google_Service_CloudUserAccounts_GroupsRemoveMemberRequest	$postBody,
			$optParams = array() )

Removes users from the specified group.

(groups.removeMember)

Parameters

string	$project	Project ID for this request.
string	$groupName	Name of the group for this request.
Google_GroupsRemoveMemberRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_Operation

◆ setIamPolicy()

Google_Service_CloudUserAccounts_Groups_Resource::setIamPolicy	(		$project,
			$resource,
		Google_Service_CloudUserAccounts_Policy	$postBody,
			$optParams = array() )

Sets the access control policy on the specified resource.

Replaces any existing policy. (groups.setIamPolicy)

Parameters

string	$project	Project ID for this request.
string	$resource	Name of the resource for this request.
Google_Policy	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_Policy

◆ testIamPermissions()

Google_Service_CloudUserAccounts_Groups_Resource::testIamPermissions	(		$project,
			$resource,
		Google_Service_CloudUserAccounts_TestPermissionsRequest	$postBody,
			$optParams = array() )

Returns permissions that a caller has on the specified resource.

(groups.testIamPermissions)

Parameters

string	$project	Project ID for this request.
string	$resource	Name of the resource for this request.
Google_TestPermissionsRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_CloudUserAccounts_TestPermissionsResponse

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

lib/google/src/Google/Service/CloudUserAccounts.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addMember()

◆ call()

◆ delete()

◆ get()

◆ getIamPolicy()

◆ insert()

◆ listGroups()

◆ removeMember()

◆ setIamPolicy()

◆ testIamPermissions()