com.google.api.services.directory

Class Directory

java.lang.Object

com.google.api.client.googleapis.services.AbstractGoogleClient

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

com.google.api.services.directory.Directory

public class Directory
extends AbstractGoogleJsonClient

Service definition for Directory (directory_v1).

Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.

For more information about this service, see the API Documentation

This service uses DirectoryRequestInitializer to initialize global parameters via its Directory.Builder.

Since:

1.3

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Directory.Asps The "asps" collection of methods.
static class	Directory.Builder Builder for Directory.
class	Directory.Channels The "channels" collection of methods.
class	Directory.Chromeosdevices The "chromeosdevices" collection of methods.
class	Directory.Customer The "customer" collection of methods.
class	Directory.Customers The "customers" collection of methods.
class	Directory.DomainAliases The "domainAliases" collection of methods.
class	Directory.Domains The "domains" collection of methods.
class	Directory.Groups The "groups" collection of methods.
class	Directory.Members The "members" collection of methods.
class	Directory.Mobiledevices The "mobiledevices" collection of methods.
class	Directory.Orgunits The "orgunits" collection of methods.
class	Directory.Privileges The "privileges" collection of methods.
class	Directory.Resources The "resources" collection of methods.
class	Directory.RoleAssignments The "roleAssignments" collection of methods.
class	Directory.Roles The "roles" collection of methods.
class	Directory.Schemas The "schemas" collection of methods.
class	Directory.Tokens The "tokens" collection of methods.
class	Directory.TwoStepVerification The "twoStepVerification" collection of methods.
class	Directory.Users The "users" collection of methods.
class	Directory.VerificationCodes The "verificationCodes" collection of methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BASE_URL The default encoded base URL of the service.
static String	DEFAULT_BATCH_PATH The default encoded batch path of the service.
static String	DEFAULT_MTLS_ROOT_URL The default encoded mTLS root URL of the service.
static String	DEFAULT_ROOT_URL The default encoded root URL of the service.
static String	DEFAULT_SERVICE_PATH The default encoded service path of the service.

Constructor Summary

Constructors

Constructor and Description
Directory(HttpTransport transport, JsonFactory jsonFactory, HttpRequestInitializer httpRequestInitializer) Constructor.

Method Summary

Modifier and Type	Method and Description
Directory.Asps	asps() An accessor for creating requests from the Asps collection.
Directory.Channels	channels() An accessor for creating requests from the Channels collection.
Directory.Chromeosdevices	chromeosdevices() An accessor for creating requests from the Chromeosdevices collection.
Directory.Customer	customer() An accessor for creating requests from the Customer collection.
Directory.Customers	customers() An accessor for creating requests from the Customers collection.
Directory.DomainAliases	domainAliases() An accessor for creating requests from the DomainAliases collection.
Directory.Domains	domains() An accessor for creating requests from the Domains collection.
Directory.Groups	groups() An accessor for creating requests from the Groups collection.
protected void	initialize(AbstractGoogleClientRequest<?> httpClientRequest)
Directory.Members	members() An accessor for creating requests from the Members collection.
Directory.Mobiledevices	mobiledevices() An accessor for creating requests from the Mobiledevices collection.
Directory.Orgunits	orgunits() An accessor for creating requests from the Orgunits collection.
Directory.Privileges	privileges() An accessor for creating requests from the Privileges collection.
Directory.Resources	resources() An accessor for creating requests from the Resources collection.
Directory.RoleAssignments	roleAssignments() An accessor for creating requests from the RoleAssignments collection.
Directory.Roles	roles() An accessor for creating requests from the Roles collection.
Directory.Schemas	schemas() An accessor for creating requests from the Schemas collection.
Directory.Tokens	tokens() An accessor for creating requests from the Tokens collection.
Directory.TwoStepVerification	twoStepVerification() An accessor for creating requests from the TwoStepVerification collection.
Directory.Users	users() An accessor for creating requests from the Users collection.
Directory.VerificationCodes	verificationCodes() An accessor for creating requests from the VerificationCodes collection.

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

getJsonFactory, getObjectParser

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClient

batch, batch, getApplicationName, getBaseUrl, getGoogleClientRequestInitializer, getRequestFactory, getRootUrl, getServicePath, getSuppressPatternChecks, getSuppressRequiredParameterChecks

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ROOT_URL

public static final String DEFAULT_ROOT_URL

The default encoded root URL of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_MTLS_ROOT_URL

public static final String DEFAULT_MTLS_ROOT_URL

The default encoded mTLS root URL of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.31

See Also:

Constant Field Values

DEFAULT_SERVICE_PATH

public static final String DEFAULT_SERVICE_PATH

The default encoded service path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_BATCH_PATH

public static final String DEFAULT_BATCH_PATH

The default encoded batch path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.23

See Also:

Constant Field Values

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

The default encoded base URL of the service. This is determined when the library is generated and normally should not be changed.

See Also:

Constant Field Values

Constructor Detail

Directory

public Directory(HttpTransport transport,
                 JsonFactory jsonFactory,
                 HttpRequestInitializer httpRequestInitializer)

Constructor.

Use Directory.Builder if you need to specify any of the optional parameters.

Parameters:

transport - HTTP transport, which should normally be:

• Google App Engine: com.google.api.client.extensions.appengine.http.UrlFetchTransport
• Android: newCompatibleTransport from com.google.api.client.extensions.android.http.AndroidHttp
• Java: GoogleNetHttpTransport

jsonFactory - JSON factory, which may be:

• Jackson: com.google.api.client.json.jackson2.JacksonFactory
• Google GSON: com.google.api.client.json.gson.GsonFactory
• Android Honeycomb or higher: com.google.api.client.extensions.android.json.AndroidJsonFactory

httpRequestInitializer - HTTP request initializer or null for none

Since:

1.7

Method Detail

initialize

protected void initialize(AbstractGoogleClientRequest<?> httpClientRequest)
                   throws IOException

Overrides:

initialize in class AbstractGoogleClient

Throws:

IOException

asps

public Directory.Asps asps()

An accessor for creating requests from the Asps collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Asps.List request = admin.asps().list(parameters ...)
 

Returns:

the resource collection

channels

public Directory.Channels channels()

An accessor for creating requests from the Channels collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Channels.List request = admin.channels().list(parameters ...)
 

Returns:

the resource collection

chromeosdevices

public Directory.Chromeosdevices chromeosdevices()

An accessor for creating requests from the Chromeosdevices collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Chromeosdevices.List request = admin.chromeosdevices().list(parameters ...)
 

Returns:

the resource collection

customer

public Directory.Customer customer()

An accessor for creating requests from the Customer collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Customer.List request = admin.customer().list(parameters ...)
 

Returns:

the resource collection

customers

public Directory.Customers customers()

An accessor for creating requests from the Customers collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Customers.List request = admin.customers().list(parameters ...)
 

Returns:

the resource collection

domainAliases

public Directory.DomainAliases domainAliases()

An accessor for creating requests from the DomainAliases collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.DomainAliases.List request = admin.domainAliases().list(parameters ...)
 

Returns:

the resource collection

domains

public Directory.Domains domains()

An accessor for creating requests from the Domains collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Domains.List request = admin.domains().list(parameters ...)
 

Returns:

the resource collection

groups

public Directory.Groups groups()

An accessor for creating requests from the Groups collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Groups.List request = admin.groups().list(parameters ...)
 

Returns:

the resource collection

members

public Directory.Members members()

An accessor for creating requests from the Members collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Members.List request = admin.members().list(parameters ...)
 

Returns:

the resource collection

mobiledevices

public Directory.Mobiledevices mobiledevices()

An accessor for creating requests from the Mobiledevices collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Mobiledevices.List request = admin.mobiledevices().list(parameters ...)
 

Returns:

the resource collection

orgunits

public Directory.Orgunits orgunits()

An accessor for creating requests from the Orgunits collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Orgunits.List request = admin.orgunits().list(parameters ...)
 

Returns:

the resource collection

privileges

public Directory.Privileges privileges()

An accessor for creating requests from the Privileges collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Privileges.List request = admin.privileges().list(parameters ...)
 

Returns:

the resource collection

resources

public Directory.Resources resources()

An accessor for creating requests from the Resources collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Resources.List request = admin.resources().list(parameters ...)
 

Returns:

the resource collection

roleAssignments

public Directory.RoleAssignments roleAssignments()

An accessor for creating requests from the RoleAssignments collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.RoleAssignments.List request = admin.roleAssignments().list(parameters ...)
 

Returns:

the resource collection

roles

public Directory.Roles roles()

An accessor for creating requests from the Roles collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Roles.List request = admin.roles().list(parameters ...)
 

Returns:

the resource collection

schemas

public Directory.Schemas schemas()

An accessor for creating requests from the Schemas collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Schemas.List request = admin.schemas().list(parameters ...)
 

Returns:

the resource collection

tokens

public Directory.Tokens tokens()

An accessor for creating requests from the Tokens collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Tokens.List request = admin.tokens().list(parameters ...)
 

Returns:

the resource collection

twoStepVerification

public Directory.TwoStepVerification twoStepVerification()

An accessor for creating requests from the TwoStepVerification collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.TwoStepVerification.List request = admin.twoStepVerification().list(parameters ...)
 

Returns:

the resource collection

users

public Directory.Users users()

An accessor for creating requests from the Users collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.Users.List request = admin.users().list(parameters ...)
 

Returns:

the resource collection

verificationCodes

public Directory.VerificationCodes verificationCodes()

An accessor for creating requests from the VerificationCodes collection.

The typical use is:

    Directory admin = new Directory(...);
    Directory.VerificationCodes.List request = admin.verificationCodes().list(parameters ...)
 

Returns:

the resource collection