Directory.Roles.List (Admin Directory API directory

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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<Roles>
        
        com.google.api.services.admin.directory.Directory.Roles.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Directory.Roles
```
public class Directory.Roles.List
extends DirectoryRequest<Roles>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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(java.lang.String customer)
Retrieves a paginated list of all the roles in a domain.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String customer)` Retrieves a paginated list of all the roles in a domain.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getCustomer()` Immutable ID of the G Suite account.
`java.lang.Integer`	`getMaxResults()` Maximum number of results to return.
`java.lang.String`	`getPageToken()` Token to specify the next page in the list.
`Directory.Roles.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Directory.Roles.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Directory.Roles.List`	`setCustomer(java.lang.String customer)` Immutable ID of the G Suite account.
`Directory.Roles.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Directory.Roles.List`	`setKey(java.lang.String key)` API key.
`Directory.Roles.List`	`setMaxResults(java.lang.Integer maxResults)` Maximum number of results to return.
`Directory.Roles.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Directory.Roles.List`	`setPageToken(java.lang.String pageToken)` Token to specify the next page in the list.
`Directory.Roles.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Directory.Roles.List`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Directory.Roles.List`	`setUserIp(java.lang.String userIp)` Deprecated.

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

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

- Constructor Detail
  - List
```
protected List(java.lang.String customer)
```
    Retrieves a paginated list of all the roles in a domain. Create a request for the method "roles.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 - Immutable ID of the G Suite account.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Roles>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Roles>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Directory.Roles.List setAlt(java.lang.String alt)
```
    Description copied from class: DirectoryRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DirectoryRequest<Roles>
  - setFields
```
public Directory.Roles.List setFields(java.lang.String fields)
```
    Description copied from class: DirectoryRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DirectoryRequest<Roles>
  - setKey
```
public Directory.Roles.List setKey(java.lang.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<Roles>
  - setOauthToken
```
public Directory.Roles.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: DirectoryRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DirectoryRequest<Roles>
  - setPrettyPrint
```
public Directory.Roles.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: DirectoryRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DirectoryRequest<Roles>
  - setQuotaUser
```
public Directory.Roles.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: DirectoryRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class DirectoryRequest<Roles>
  - setUserIp
```
public Directory.Roles.List setUserIp(java.lang.String userIp)
```
    Description copied from class: DirectoryRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class DirectoryRequest<Roles>
  - getCustomer
```
public java.lang.String getCustomer()
```
    Immutable ID of the G Suite account.
  - setCustomer
```
public Directory.Roles.List setCustomer(java.lang.String customer)
```
    Immutable ID of the G Suite account.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    Maximum number of results to return. [minimum: 1] [maximum: 100]
  - setMaxResults
```
public Directory.Roles.List setMaxResults(java.lang.Integer maxResults)
```
    Maximum number of results to return.
  - getPageToken
```
public java.lang.String getPageToken()
```
    Token to specify the next page in the list.
  - setPageToken
```
public Directory.Roles.List setPageToken(java.lang.String pageToken)
```
    Token to specify the next page in the list.
  - set
```
public Directory.Roles.List set(java.lang.String parameterName,
                                java.lang.Object value)
```
    Overrides:
    
    set in class DirectoryRequest<Roles>

Admin Directory API directory_v1 (revision 118)

Class Directory.Roles.List

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getCustomer

setCustomer

getMaxResults

setMaxResults

getPageToken

setPageToken

set