Gmail.Users.Settings.Cse.Identities.List (Gmail API v1-rev20221219-2.0.0)

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.gmail.GmailRequest<ListCseIdentitiesResponse>
        
        com.google.api.services.gmail.Gmail.Users.Settings.Cse.Identities.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Settings.Cse.Identities
```
public class Gmail.Users.Settings.Cse.Identities.List
extends GmailRequest<ListCseIdentitiesResponse>
```

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 userId)
Lists the client-side encrypted identities for an authenticated user.

Constructors
Modifier	Constructor and Description
`protected`	`List(String userId)` Lists the client-side encrypted identities for an authenticated user.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`Integer`	`getPageSize()` The number of identities to return.
`String`	`getPageToken()` Pagination token indicating which page of identities to return.
`String`	`getUserId()` The requester's primary email address.
`Gmail.Users.Settings.Cse.Identities.List`	`set(String parameterName, Object value)`
`Gmail.Users.Settings.Cse.Identities.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Gmail.Users.Settings.Cse.Identities.List`	`setAccessToken(String accessToken)` OAuth access token.
`Gmail.Users.Settings.Cse.Identities.List`	`setAlt(String alt)` Data format for response.
`Gmail.Users.Settings.Cse.Identities.List`	`setCallback(String callback)` JSONP
`Gmail.Users.Settings.Cse.Identities.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Gmail.Users.Settings.Cse.Identities.List`	`setKey(String key)` API key.
`Gmail.Users.Settings.Cse.Identities.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Gmail.Users.Settings.Cse.Identities.List`	`setPageSize(Integer pageSize)` The number of identities to return.
`Gmail.Users.Settings.Cse.Identities.List`	`setPageToken(String pageToken)` Pagination token indicating which page of identities to return.
`Gmail.Users.Settings.Cse.Identities.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Gmail.Users.Settings.Cse.Identities.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Gmail.Users.Settings.Cse.Identities.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Gmail.Users.Settings.Cse.Identities.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Gmail.Users.Settings.Cse.Identities.List`	`setUserId(String userId)` The requester's primary email address.

Methods inherited from class com.google.api.services.gmail.GmailRequest
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.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 userId)
```
    Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html). Create a request for the method "identities.list". This request holds the parameters needed by the the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Gmail.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListCseIdentitiesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListCseIdentitiesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Gmail.Users.Settings.Cse.Identities.List set$Xgafv(String $Xgafv)
```
    Description copied from class: GmailRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class GmailRequest<ListCseIdentitiesResponse>
  - setAccessToken
```
public Gmail.Users.Settings.Cse.Identities.List setAccessToken(String accessToken)
```
    Description copied from class: GmailRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class GmailRequest<ListCseIdentitiesResponse>
  - setAlt
```
public Gmail.Users.Settings.Cse.Identities.List setAlt(String alt)
```
    Description copied from class: GmailRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class GmailRequest<ListCseIdentitiesResponse>
  - setCallback
```
public Gmail.Users.Settings.Cse.Identities.List setCallback(String callback)
```
    Description copied from class: GmailRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class GmailRequest<ListCseIdentitiesResponse>
  - setFields
```
public Gmail.Users.Settings.Cse.Identities.List setFields(String fields)
```
    Description copied from class: GmailRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class GmailRequest<ListCseIdentitiesResponse>
  - setKey
```
public Gmail.Users.Settings.Cse.Identities.List setKey(String key)
```
    Description copied from class: GmailRequest
    
    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 GmailRequest<ListCseIdentitiesResponse>
  - setOauthToken
```
public Gmail.Users.Settings.Cse.Identities.List setOauthToken(String oauthToken)
```
    Description copied from class: GmailRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class GmailRequest<ListCseIdentitiesResponse>
  - setPrettyPrint
```
public Gmail.Users.Settings.Cse.Identities.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: GmailRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class GmailRequest<ListCseIdentitiesResponse>
  - setQuotaUser
```
public Gmail.Users.Settings.Cse.Identities.List setQuotaUser(String quotaUser)
```
    Description copied from class: GmailRequest
    
    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 GmailRequest<ListCseIdentitiesResponse>
  - setUploadType
```
public Gmail.Users.Settings.Cse.Identities.List setUploadType(String uploadType)
```
    Description copied from class: GmailRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class GmailRequest<ListCseIdentitiesResponse>
  - setUploadProtocol
```
public Gmail.Users.Settings.Cse.Identities.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: GmailRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class GmailRequest<ListCseIdentitiesResponse>
  - getUserId
```
public String getUserId()
```
    The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]
  - setUserId
```
public Gmail.Users.Settings.Cse.Identities.List setUserId(String userId)
```
    The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
  - getPageSize
```
public Integer getPageSize()
```
    The number of identities to return. If not provided, the page size will default to 20 entries. [default: 20]
  - setPageSize
```
public Gmail.Users.Settings.Cse.Identities.List setPageSize(Integer pageSize)
```
    The number of identities to return. If not provided, the page size will default to 20 entries.
  - getPageToken
```
public String getPageToken()
```
    Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.
  - setPageToken
```
public Gmail.Users.Settings.Cse.Identities.List setPageToken(String pageToken)
```
    Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.
  - set
```
public Gmail.Users.Settings.Cse.Identities.List set(String parameterName,
                                                    Object value)
```
    Overrides:
    
    set in class GmailRequest<ListCseIdentitiesResponse>

Class Gmail.Users.Settings.Cse.Identities.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.gmail.GmailRequest

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

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getUserId

setUserId

getPageSize

setPageSize

getPageToken

setPageToken

set