Documentation

Google_Service_Directory_Resource_ResourcesBuildings extends Google_Service_Resource
in package

Application

The "buildings" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $buildings = $adminService->buildings;

$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: Deletes a building. (buildings.delete)
get() : Google_Service_Directory_Building: Retrieves a building. (buildings.get)
insert() : Google_Service_Directory_Building: Inserts a building. (buildings.insert)
listResourcesBuildings() : Google_Service_Directory_Buildings: Retrieves a list of buildings for an account.
patch() : Google_Service_Directory_Building: Patches a building via Apiary Patch Orchestration. (buildings.patch)
update() : Google_Service_Directory_Building: Updates a building. (buildings.update)
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 —

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 building. (buildings.delete)


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

Parameters

$customer : string: The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
$buildingId : string: The id of the building to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Retrieves a building. (buildings.get)


    public
                get(string $customer, string $buildingId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Building

Parameters

$customer : string: The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
$buildingId : string: The unique ID of the building to retrieve.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Building —

insert()

Inserts a building. (buildings.insert)


    public
                insert(string $customer, Google_Service_Directory_Building $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Building

Parameters

$customer : string: The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
$postBody : Google_Service_Directory_Building
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Building —

listResourcesBuildings()

Retrieves a list of buildings for an account.


    public
                listResourcesBuildings(string $customer[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Buildings

(buildings.listResourcesBuildings)

Parameters

$customer : string: The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Buildings —

patch()

Patches a building via Apiary Patch Orchestration. (buildings.patch)


    public
                patch(string $customer, string $buildingId, Google_Service_Directory_Building $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Building

Parameters

$customer : string: The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
$buildingId : string: The id of the building to update.
$postBody : Google_Service_Directory_Building
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Building —

update()

Updates a building. (buildings.update)


    public
                update(string $customer, string $buildingId, Google_Service_Directory_Building $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Building

Parameters

$customer : string: The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
$buildingId : string: The id of the building to update.
$postBody : Google_Service_Directory_Building
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Building —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —