Gmail.Users.History.List (Gmail API v1-rev20240520-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<ListHistoryResponse>
        
        com.google.api.services.gmail.Gmail.Users.History.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.History
```
public class Gmail.Users.History.List
extends GmailRequest<ListHistoryResponse>
```

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
  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
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String userId)
Lists the history of all changes to the given mailbox.

Constructors
Modifier	Constructor and Description
`protected`	`List(String userId)` Lists the history of all changes to the given mailbox.

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()`
`List<String>`	`getHistoryTypes()` History types to be returned by the function
`String`	`getLabelId()` Only return messages with a label matching the ID.
`Long`	`getMaxResults()` Maximum number of history records to return.
`String`	`getPageToken()` Page token to retrieve a specific page of results in the list.
`BigInteger`	`getStartHistoryId()` Required.
`String`	`getUserId()` The user's email address.
`Gmail.Users.History.List`	`set(String parameterName, Object value)`
`Gmail.Users.History.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Gmail.Users.History.List`	`setAccessToken(String accessToken)` OAuth access token.
`Gmail.Users.History.List`	`setAlt(String alt)` Data format for response.
`Gmail.Users.History.List`	`setCallback(String callback)` JSONP
`Gmail.Users.History.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Gmail.Users.History.List`	`setHistoryTypes(List<String> historyTypes)` History types to be returned by the function
`Gmail.Users.History.List`	`setKey(String key)` API key.
`Gmail.Users.History.List`	`setLabelId(String labelId)` Only return messages with a label matching the ID.
`Gmail.Users.History.List`	`setMaxResults(Long maxResults)` Maximum number of history records to return.
`Gmail.Users.History.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Gmail.Users.History.List`	`setPageToken(String pageToken)` Page token to retrieve a specific page of results in the list.
`Gmail.Users.History.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Gmail.Users.History.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Gmail.Users.History.List`	`setStartHistoryId(BigInteger startHistoryId)` Required.
`Gmail.Users.History.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Gmail.Users.History.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Gmail.Users.History.List`	`setUserId(String userId)` The user's 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.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 userId)
```
    Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`). Create a request for the method "history.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 user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListHistoryResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListHistoryResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Gmail.Users.History.List set$Xgafv(String $Xgafv)
```
    Description copied from class: GmailRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class GmailRequest<ListHistoryResponse>
  - setAccessToken
```
public Gmail.Users.History.List setAccessToken(String accessToken)
```
    Description copied from class: GmailRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class GmailRequest<ListHistoryResponse>
  - setAlt
```
public Gmail.Users.History.List setAlt(String alt)
```
    Description copied from class: GmailRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class GmailRequest<ListHistoryResponse>
  - setCallback
```
public Gmail.Users.History.List setCallback(String callback)
```
    Description copied from class: GmailRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class GmailRequest<ListHistoryResponse>
  - setFields
```
public Gmail.Users.History.List setFields(String fields)
```
    Description copied from class: GmailRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class GmailRequest<ListHistoryResponse>
  - setKey
```
public Gmail.Users.History.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<ListHistoryResponse>
  - setOauthToken
```
public Gmail.Users.History.List setOauthToken(String oauthToken)
```
    Description copied from class: GmailRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class GmailRequest<ListHistoryResponse>
  - setPrettyPrint
```
public Gmail.Users.History.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: GmailRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class GmailRequest<ListHistoryResponse>
  - setQuotaUser
```
public Gmail.Users.History.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<ListHistoryResponse>
  - setUploadType
```
public Gmail.Users.History.List setUploadType(String uploadType)
```
    Description copied from class: GmailRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class GmailRequest<ListHistoryResponse>
  - setUploadProtocol
```
public Gmail.Users.History.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: GmailRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class GmailRequest<ListHistoryResponse>
  - getUserId
```
public String getUserId()
```
    The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]
  - setUserId
```
public Gmail.Users.History.List setUserId(String userId)
```
    The user's email address. The special value `me` can be used to indicate the authenticated user.
  - getHistoryTypes
```
public List<String> getHistoryTypes()
```
    History types to be returned by the function
  - setHistoryTypes
```
public Gmail.Users.History.List setHistoryTypes(List<String> historyTypes)
```
    History types to be returned by the function
  - getLabelId
```
public String getLabelId()
```
    Only return messages with a label matching the ID.
  - setLabelId
```
public Gmail.Users.History.List setLabelId(String labelId)
```
    Only return messages with a label matching the ID.
  - getMaxResults
```
public Long getMaxResults()
```
    Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500. [default: 100]
  - setMaxResults
```
public Gmail.Users.History.List setMaxResults(Long maxResults)
```
    Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.
  - getPageToken
```
public String getPageToken()
```
    Page token to retrieve a specific page of results in the list.
  - setPageToken
```
public Gmail.Users.History.List setPageToken(String pageToken)
```
    Page token to retrieve a specific page of results in the list.
  - getStartHistoryId
```
public BigInteger getStartHistoryId()
```
    Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request.
  - setStartHistoryId
```
public Gmail.Users.History.List setStartHistoryId(BigInteger startHistoryId)
```
    Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request.
  - set
```
public Gmail.Users.History.List set(String parameterName,
                                    Object value)
```
    Overrides:
    
    set in class GmailRequest<ListHistoryResponse>

Class Gmail.Users.History.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

getHistoryTypes

setHistoryTypes

getLabelId

setLabelId

getMaxResults

setMaxResults

getPageToken

setPageToken

getStartHistoryId

setStartHistoryId

set