• Home
• com.google.apis
• google-api-services-admin-directory
• directory_v1-rev20220802-2.0.0
• source code
• Directory.Members.List.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.directory.Directory.Members.List.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.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.directory.DirectoryRequest<Members>


com.google.api.services.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>








Field Summary




Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
List(String groupKey)
Retrieves a paginated list of all members in a group.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HttpRequest
buildHttpRequestUsingHead() 


HttpResponse
executeUsingHead() 


String
getGroupKey()
Identifies the group in the API request.



Boolean
getIncludeDerivedMembership()
Whether to list indirect memberships.



Integer
getMaxResults()
Maximum number of results to return.



String
getPageToken()
Token to specify next page in the list.



String
getRoles()
The `roles` query parameter allows you to retrieve group members by role.



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


Directory.Members.List
set$Xgafv(String $Xgafv)
V1 error format.



Directory.Members.List
setAccessToken(String accessToken)
OAuth access token.



Directory.Members.List
setAlt(String alt)
Data format for response.



Directory.Members.List
setCallback(String callback)
JSONP



Directory.Members.List
setFields(String fields)
Selector specifying which fields to include in a partial response.



Directory.Members.List
setGroupKey(String groupKey)
Identifies the group in the API request.



Directory.Members.List
setIncludeDerivedMembership(Boolean includeDerivedMembership)
Whether to list indirect memberships.



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)
The `roles` query parameter allows you to retrieve group members by role.



Directory.Members.List
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Directory.Members.List
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.







Methods inherited from class com.google.api.services.directory.DirectoryRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





List
protected List(String groupKey)
Retrieves a paginated list of all members in a group.

 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 - Identifies the group in the API request. The value can be the group's email address, group alias, or
        the unique group ID.
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








set$Xgafv
public Directory.Members.List set$Xgafv(String $Xgafv)
Description copied from class: DirectoryRequest
V1 error format.

Overrides:
set$Xgafv in class DirectoryRequest<Members>








setAccessToken
public Directory.Members.List setAccessToken(String accessToken)
Description copied from class: DirectoryRequest
OAuth access token.

Overrides:
setAccessToken in class DirectoryRequest<Members>








setAlt
public Directory.Members.List setAlt(String alt)
Description copied from class: DirectoryRequest
Data format for response.

Overrides:
setAlt in class DirectoryRequest<Members>








setCallback
public Directory.Members.List setCallback(String callback)
Description copied from class: DirectoryRequest
JSONP

Overrides:
setCallback 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:
setQuotaUser in class DirectoryRequest<Members>








setUploadType
public Directory.Members.List setUploadType(String uploadType)
Description copied from class: DirectoryRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class DirectoryRequest<Members>








setUploadProtocol
public Directory.Members.List setUploadProtocol(String uploadProtocol)
Description copied from class: DirectoryRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class DirectoryRequest<Members>








getGroupKey
public String getGroupKey()
Identifies the group in the API request. The value can be the group's email address, group alias,
     or the unique group ID.







setGroupKey
public Directory.Members.List setGroupKey(String groupKey)
Identifies the group in the API request. The value can be the group's email address, group
 alias, or the unique group ID.







getIncludeDerivedMembership
public Boolean getIncludeDerivedMembership()
Whether to list indirect memberships. Default: false.







setIncludeDerivedMembership
public Directory.Members.List setIncludeDerivedMembership(Boolean includeDerivedMembership)
Whether to list indirect memberships. Default: false.







getMaxResults
public Integer getMaxResults()
Maximum number of results to return. Max allowed value is 200. [default: 200] [minimum: 1]







setMaxResults
public Directory.Members.List setMaxResults(Integer maxResults)
Maximum number of results to return. Max allowed value is 200.







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()
The `roles` query parameter allows you to retrieve group members by role. Allowed values are
     `OWNER`, `MANAGER`, and `MEMBER`.







setRoles
public Directory.Members.List setRoles(String roles)
The `roles` query parameter allows you to retrieve group members by role. Allowed values
 are `OWNER`, `MANAGER`, and `MEMBER`.







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

Overrides:
set in class DirectoryRequest<Members>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.