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

Schemas

class Schemas extends Resource (View source)

The "schemas" collection of methods.

Typical usage is:

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

Methods

delete(string $customerId, string $schemaKey, array $optParams = [])

Deletes a schema. (schemas.delete)

Schema
get(string $customerId, string $schemaKey, array $optParams = [])

Retrieves a schema. (schemas.get)

Schema
insert(string $customerId, Schema $postBody, array $optParams = [])

Creates a schema. (schemas.insert)

Schemas
listSchemas(string $customerId, array $optParams = [])

Retrieves all schemas for a customer. (schemas.listSchemas)

Schema
patch(string $customerId, string $schemaKey, Schema $postBody, array $optParams = [])

Patches a schema. (schemas.patch)

Schema
update(string $customerId, string $schemaKey, Schema $postBody, array $optParams = [])

Updates a schema. (schemas.update)

Details

at line 41
delete(string $customerId, string $schemaKey, array $optParams = [])

Deletes a schema. (schemas.delete)

Parameters

string $customerId

Immutable ID of the Google Workspace account.
string $schemaKey

Name or immutable ID of the schema.
array $optParams

Optional parameters.

Exceptions

Exception

at line 62
Schema get(string $customerId, string $schemaKey, array $optParams = [])

Retrieves a schema. (schemas.get)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.
string $schemaKey

Name or immutable ID of the schema.
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 77
Schema insert(string $customerId, Schema $postBody, array $optParams = [])

Creates a schema. (schemas.insert)

Parameters

string $customerId

Immutable ID of the Google Workspace account.
Schema $postBody
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 97
Schemas listSchemas(string $customerId, array $optParams = [])

Retrieves all schemas for a customer. (schemas.listSchemas)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.
array $optParams

Optional parameters.

Return Value

Schemas

Exceptions

Exception

at line 113
Schema patch(string $customerId, string $schemaKey, Schema $postBody, array $optParams = [])

Patches a schema. (schemas.patch)

Parameters

string $customerId

Immutable ID of the Google Workspace account.
string $schemaKey

Name or immutable ID of the schema.
Schema $postBody
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception

at line 129
Schema update(string $customerId, string $schemaKey, Schema $postBody, array $optParams = [])

Updates a schema. (schemas.update)

Parameters

string $customerId

Immutable ID of the Google Workspace account.
string $schemaKey

Name or immutable ID of the schema.
Schema $postBody
array $optParams

Optional parameters.

Return Value

Schema

Exceptions

Exception