com.google.api.services.admin.directory

Class Directory.Members.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<Members>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Directory.Members

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

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.Members.List(String groupKey) Retrieve all members in a group (paginated) Create a request for the method "members.list".

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getGroupKey() Email or immutable Id of the group
Integer	getMaxResults() Maximum number of results to return.
String	getPageToken() Token to specify next page in the list
String	getRoles() Comma separated role values to filter list results on.
Directory.Members.List	set(String parameterName, Object value)
Directory.Members.List	setAlt(String alt) Data format for the response.
Directory.Members.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Directory.Members.List	setGroupKey(String groupKey) Email or immutable Id of the group
Directory.Members.List	setKey(String key) API key.
Directory.Members.List	setMaxResults(Integer maxResults) Maximum number of results to return.
Directory.Members.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Directory.Members.List	setPageToken(String pageToken) Token to specify next page in the list
Directory.Members.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Directory.Members.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Directory.Members.List	setRoles(String roles) Comma separated role values to filter list results on.
Directory.Members.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.Members.List

protected Directory.Members.List(String groupKey)

Retrieve all members in a group (paginated) Create a request for the method "members.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:

groupKey - Email or immutable Id of the group

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Members>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Members>

Throws:

IOException

setAlt

public Directory.Members.List setAlt(String alt)

Description copied from class: DirectoryRequest

Data format for the response.

Overrides:

setAlt in class DirectoryRequest<Members>

setFields

public Directory.Members.List setFields(String fields)

Description copied from class: DirectoryRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DirectoryRequest<Members>

setKey

public Directory.Members.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<Members>

setOauthToken

public Directory.Members.List setOauthToken(String oauthToken)

Description copied from class: DirectoryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DirectoryRequest<Members>

setPrettyPrint

public Directory.Members.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DirectoryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DirectoryRequest<Members>

setQuotaUser

public Directory.Members.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<Members>

setUserIp

public Directory.Members.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<Members>

getGroupKey

public String getGroupKey()

Email or immutable Id of the group

setGroupKey

public Directory.Members.List setGroupKey(String groupKey)

Email or immutable Id of the group

getPageToken

public String getPageToken()

Token to specify next page in the list

setPageToken

public Directory.Members.List setPageToken(String pageToken)

Token to specify next page in the list

getRoles

public String getRoles()

Comma separated role values to filter list results on.

setRoles

public Directory.Members.List setRoles(String roles)

Comma separated role values to filter list results on.

getMaxResults

public Integer getMaxResults()

Maximum number of results to return. Default is 200 [minimum: 1]

setMaxResults

public Directory.Members.List setMaxResults(Integer maxResults)

Maximum number of results to return. Default is 200

set

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

Overrides:

set in class DirectoryRequest<Members>