1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. ResourcesBuildings

ResourcesBuildings

class ResourcesBuildings extends Resource (View source)

The "buildings" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $buildings = $adminService->resources_buildings;

Methods

delete(string $customer, string $buildingId, array $optParams = [])

Deletes a building. (buildings.delete)

Building
get(string $customer, string $buildingId, array $optParams = [])

Retrieves a building. (buildings.get)

Building
insert(string $customer, Building $postBody, array $optParams = [])

Inserts a building. (buildings.insert)

Buildings
listResourcesBuildings(string $customer, array $optParams = [])

Retrieves a list of buildings for an account.

Building
patch(string $customer, string $buildingId, Building $postBody, array $optParams = [])

Patches a building. (buildings.patch)

Building
update(string $customer, string $buildingId, Building $postBody, array $optParams = [])

Updates a building. (buildings.update)

Details

at line 43
delete(string $customer, string $buildingId, array $optParams = [])

Deletes a building. (buildings.delete)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $buildingId

The id of the building to delete.
array $optParams

Optional parameters.

Exceptions

Exception

at line 60
Building get(string $customer, string $buildingId, array $optParams = [])

Retrieves a building. (buildings.get)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $buildingId

The unique ID of the building to retrieve.
array $optParams

Optional parameters.

Return Value

Building

Exceptions

Exception

at line 80
Building insert(string $customer, Building $postBody, array $optParams = [])

Inserts a building. (buildings.insert)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
Building $postBody
array $optParams

Optional parameters.

Return Value

Building

Exceptions

Exception

at line 100
Buildings listResourcesBuildings(string $customer, array $optParams = [])

Retrieves a list of buildings for an account.

(buildings.listResourcesBuildings)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
array $optParams

Optional parameters.

Return Value

Buildings

Exceptions

Exception

at line 121
Building patch(string $customer, string $buildingId, Building $postBody, array $optParams = [])

Patches a building. (buildings.patch)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $buildingId

The id of the building to update.
Building $postBody
array $optParams

Optional parameters.

Return Value

Building

Exceptions

Exception

at line 142
Building update(string $customer, string $buildingId, Building $postBody, array $optParams = [])

Updates a building. (buildings.update)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $buildingId

The id of the building to update.
Building $postBody
array $optParams

Optional parameters.

Return Value

Building

Exceptions

Exception