Google_Service_Directory_Resource_Orgunits
extends Google_Service_Resource
in package
The "orgunits" collection of methods.
Typical usage is:
$adminService = new Google_Service_Directory(...);
$orgunits = $adminService->orgunits;
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.
- createRequestUri() : string
- Parse/expand request parameters and create a fully qualified request uri.
- delete() : mixed
- Remove organizational unit (orgunits.delete)
- get() : Google_Service_Directory_OrgUnit
- Retrieve organizational unit (orgunits.get)
- insert() : Google_Service_Directory_OrgUnit
- Add organizational unit (orgunits.insert)
- listOrgunits() : Google_Service_Directory_OrgUnits
- Retrieve all organizational units (orgunits.listOrgunits)
- patch() : Google_Service_Directory_OrgUnit
- Patch organization unit via Apiary Patch Orchestration (orgunits.patch)
- update() : Google_Service_Directory_OrgUnit
- Update organizational unit (orgunits.update)
- convertToArrayAndStripNulls() : mixed
Properties
$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'))
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
Tags
Return values
Google_Http_Request|expectedClass —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
Return values
string —$requestUrl
delete()
Remove organizational unit (orgunits.delete)
public
delete(string $customerId, string $orgUnitPath[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
- $customerId : string
-
Immutable ID of the G Suite account
- $orgUnitPath : string
-
Full path of the organizational unit or its ID
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —get()
Retrieve organizational unit (orgunits.get)
public
get(string $customerId, string $orgUnitPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_OrgUnit
Parameters
- $customerId : string
-
Immutable ID of the G Suite account
- $orgUnitPath : string
-
Full path of the organizational unit or its ID
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Directory_OrgUnit —insert()
Add organizational unit (orgunits.insert)
public
insert(string $customerId, Google_Service_Directory_OrgUnit $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_OrgUnit
Parameters
- $customerId : string
-
Immutable ID of the G Suite account
- $postBody : Google_Service_Directory_OrgUnit
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Directory_OrgUnit —listOrgunits()
Retrieve all organizational units (orgunits.listOrgunits)
public
listOrgunits(string $customerId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_OrgUnits
Parameters
- $customerId : string
-
Immutable ID of the G Suite account
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Tags
Return values
Google_Service_Directory_OrgUnits —patch()
Patch organization unit via Apiary Patch Orchestration (orgunits.patch)
public
patch(string $customerId, string $orgUnitPath, Google_Service_Directory_OrgUnit $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_OrgUnit
Parameters
- $customerId : string
-
Immutable ID of the G Suite account
- $orgUnitPath : string
-
Full path of the organizational unit or its ID
- $postBody : Google_Service_Directory_OrgUnit
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Directory_OrgUnit —update()
Update organizational unit (orgunits.update)
public
update(string $customerId, string $orgUnitPath, Google_Service_Directory_OrgUnit $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_OrgUnit
Parameters
- $customerId : string
-
Immutable ID of the G Suite account
- $orgUnitPath : string
-
Full path of the organizational unit or its ID
- $postBody : Google_Service_Directory_OrgUnit
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Directory_OrgUnit —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed