com.google.api.services.admin.directory

Class Directory.Notifications.List

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.admin.directory.DirectoryRequest<Notifications>

com.google.api.services.admin.directory.Directory.Notifications.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Directory.Notifications

public class Directory.Notifications.List
extends DirectoryRequest<Notifications>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Directory.Notifications.List(String customer) Retrieves a list of notifications.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getCustomer() The unique ID for the customer's Google account.
String	getLanguage() The ISO 639-1 code of the language notifications are returned in.
Long	getMaxResults() Maximum number of notifications to return per page.
String	getPageToken() The token to specify the page of results to retrieve.
Directory.Notifications.List	set(String parameterName, Object value)
Directory.Notifications.List	setAlt(String alt) Data format for the response.
Directory.Notifications.List	setCustomer(String customer) The unique ID for the customer's Google account.
Directory.Notifications.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Directory.Notifications.List	setKey(String key) API key.
Directory.Notifications.List	setLanguage(String language) The ISO 639-1 code of the language notifications are returned in.
Directory.Notifications.List	setMaxResults(Long maxResults) Maximum number of notifications to return per page.
Directory.Notifications.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Directory.Notifications.List	setPageToken(String pageToken) The token to specify the page of results to retrieve.
Directory.Notifications.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Directory.Notifications.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Directory.Notifications.List	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.admin.directory.DirectoryRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

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

getJsonContent, newExceptionOnError, queue

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

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Directory.Notifications.List

protected Directory.Notifications.List(String customer)

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

Directory.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

customer - The unique ID for the customer's Google account.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Notifications>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Notifications>

Throws:

IOException

setAlt

public Directory.Notifications.List setAlt(String alt)

Description copied from class: DirectoryRequest

Data format for the response.

Overrides:

setAlt in class DirectoryRequest<Notifications>

setFields

public Directory.Notifications.List setFields(String fields)

Description copied from class: DirectoryRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DirectoryRequest<Notifications>

setKey

public Directory.Notifications.List setKey(String key)

Description copied from class: DirectoryRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DirectoryRequest<Notifications>

setOauthToken

public Directory.Notifications.List setOauthToken(String oauthToken)

Description copied from class: DirectoryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DirectoryRequest<Notifications>

setPrettyPrint

public Directory.Notifications.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DirectoryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DirectoryRequest<Notifications>

setQuotaUser

public Directory.Notifications.List setQuotaUser(String quotaUser)

Description copied from class: DirectoryRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class DirectoryRequest<Notifications>

setUserIp

public Directory.Notifications.List setUserIp(String userIp)

Description copied from class: DirectoryRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DirectoryRequest<Notifications>

getCustomer

public String getCustomer()

The unique ID for the customer's Google account.

setCustomer

public Directory.Notifications.List setCustomer(String customer)

The unique ID for the customer's Google account.

getPageToken

public String getPageToken()

The token to specify the page of results to retrieve.

setPageToken

public Directory.Notifications.List setPageToken(String pageToken)

The token to specify the page of results to retrieve.

getMaxResults

public Long getMaxResults()

Maximum number of notifications to return per page. The default is 100.

setMaxResults

public Directory.Notifications.List setMaxResults(Long maxResults)

Maximum number of notifications to return per page. The default is 100.

getLanguage

public String getLanguage()

The ISO 639-1 code of the language notifications are returned in. The default is English (en).

setLanguage

public Directory.Notifications.List setLanguage(String language)

The ISO 639-1 code of the language notifications are returned in. The default is English (en).

set

public Directory.Notifications.List set(String parameterName,
                               Object value)

Overrides:

set in class DirectoryRequest<Notifications>