com.google.api.services.directory

Class Directory.Schemas

java.lang.Object

com.google.api.services.directory.Directory.Schemas

Enclosing class:

Directory

public class Directory.Schemas
extends Object

The "schemas" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Directory.Schemas.Delete
class	Directory.Schemas.Get
class	Directory.Schemas.Insert
class	Directory.Schemas.List
class	Directory.Schemas.Patch
class	Directory.Schemas.Update

Constructor Summary

Constructors

Constructor and Description
Schemas()

Method Summary

Modifier and Type	Method and Description
Directory.Schemas.Delete	delete(String customerId, String schemaKey) Deletes a schema.
Directory.Schemas.Get	get(String customerId, String schemaKey) Retrieves a schema.
Directory.Schemas.Insert	insert(String customerId, Schema content) Creates a schema.
Directory.Schemas.List	list(String customerId) Retrieves all schemas for a customer.
Directory.Schemas.Patch	patch(String customerId, String schemaKey, Schema content) Patches a schema.
Directory.Schemas.Update	update(String customerId, String schemaKey, Schema content) Updates a schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Schemas

public Schemas()

Method Detail

delete

public Directory.Schemas.Delete delete(String customerId,
                                       String schemaKey)
                                throws IOException

Deletes a schema. Create a request for the method "schemas.delete". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customerId - Immutable ID of the Google Workspace account.

schemaKey - Name or immutable ID of the schema.

Returns:

the request

Throws:

IOException

get

public Directory.Schemas.Get get(String customerId,
                                 String schemaKey)
                          throws IOException

Retrieves a schema. Create a request for the method "schemas.get". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.

schemaKey - Name or immutable ID of the schema.

Returns:

the request

Throws:

IOException

insert

public Directory.Schemas.Insert insert(String customerId,
                                       Schema content)
                                throws IOException

Creates a schema. Create a request for the method "schemas.insert". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customerId - Immutable ID of the Google Workspace account.

content - the Schema

Returns:

the request

Throws:

IOException

list

public Directory.Schemas.List list(String customerId)
                            throws IOException

Retrieves all schemas for a customer. Create a request for the method "schemas.list". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.

Returns:

the request

Throws:

IOException

patch

public Directory.Schemas.Patch patch(String customerId,
                                     String schemaKey,
                                     Schema content)
                              throws IOException

Patches a schema. Create a request for the method "schemas.patch". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customerId - Immutable ID of the Google Workspace account.

schemaKey - Name or immutable ID of the schema.

content - the Schema

Returns:

the request

Throws:

IOException

update

public Directory.Schemas.Update update(String customerId,
                                       String schemaKey,
                                       Schema content)
                                throws IOException

Updates a schema. Create a request for the method "schemas.update". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customerId - Immutable ID of the Google Workspace account.

schemaKey - Name or immutable ID of the schema.

content - the Schema

Returns:

the request

Throws:

IOException