Documentation

Google_Service_CloudIdentity_Resource_GroupsMemberships extends Google_Service_Resource
in package

Application

The "memberships" collection of methods.

Typical usage is: $cloudidentityService = new Google_Service_CloudIdentity(...); $memberships = $cloudidentityService->memberships;

$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_CloudIdentity_Operation: Creates a `Membership`. (memberships.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudIdentity_Operation: Deletes a `Membership`. (memberships.delete)
get() : Google_Service_CloudIdentity_Membership: Retrieves a `Membership`. (memberships.get)
listGroupsMemberships() : Google_Service_CloudIdentity_ListMembershipsResponse: Lists the `Membership`s within a `Group`. (memberships.listGroupsMemberships)
lookup() : Google_Service_CloudIdentity_LookupMembershipNameResponse: Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`. (memberships.lookup)
modifyMembershipRoles() : Google_Service_CloudIdentity_ModifyMembershipRolesResponse: Modifies the `MembershipRole`s of a `Membership`.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a `Membership`. (memberships.create)


    public
                create(string $parent, Google_Service_CloudIdentity_Membership $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation

Parameters

$parent : string: Required. The parent Group resource under which to create the Membership. Must be of the form groups/{group_id}.
$postBody : Google_Service_CloudIdentity_Membership
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIdentity_Operation —

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>

Return values

string —

$requestUrl

delete()

Deletes a `Membership`. (memberships.delete)


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

Parameters

$name : string: Required. The resource name of the Membership to delete. Must be of the form groups/{group_id}/memberships/{membership_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIdentity_Operation —

get()

Retrieves a `Membership`. (memberships.get)


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

Parameters

$name : string: Required. The resource name of the Membership to retrieve. Must be of the form groups/{group_id}/memberships/{membership_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIdentity_Membership —

listGroupsMemberships()

Lists the `Membership`s within a `Group`. (memberships.listGroupsMemberships)


    public
                listGroupsMemberships(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_ListMembershipsResponse

Parameters

$parent : string: Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIdentity_ListMembershipsResponse —

lookup()

Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`. (memberships.lookup)


    public
                lookup(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_LookupMembershipNameResponse

Parameters

$parent : string: Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIdentity_LookupMembershipNameResponse —

modifyMembershipRoles()

Modifies the `MembershipRole`s of a `Membership`.


    public
                modifyMembershipRoles(string $name, Google_Service_CloudIdentity_ModifyMembershipRolesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_ModifyMembershipRolesResponse

(memberships.modifyMembershipRoles)

Parameters

$name : string: Required. The resource name of the Membership whose roles are to be modified. Must be of the form groups/{group_id}/memberships/{membership_id}.
$postBody : Google_Service_CloudIdentity_ModifyMembershipRolesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudIdentity_ModifyMembershipRolesResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —