GmailRequest (Gmail API v1 (Rev. 110) 1.25.0)

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.gmail.GmailRequest<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

Gmail.Users.Drafts.Create, Gmail.Users.Drafts.Delete, Gmail.Users.Drafts.Get, Gmail.Users.Drafts.List, Gmail.Users.Drafts.Send, Gmail.Users.Drafts.Update, Gmail.Users.GetProfile, Gmail.Users.History.List, Gmail.Users.Labels.Create, Gmail.Users.Labels.Delete, Gmail.Users.Labels.Get, Gmail.Users.Labels.List, Gmail.Users.Labels.Patch, Gmail.Users.Labels.Update, Gmail.Users.Messages.Attachments.Get, Gmail.Users.Messages.BatchDelete, Gmail.Users.Messages.BatchModify, Gmail.Users.Messages.Delete, Gmail.Users.Messages.Get, Gmail.Users.Messages.GmailImport, Gmail.Users.Messages.Insert, Gmail.Users.Messages.List, Gmail.Users.Messages.Modify, Gmail.Users.Messages.Send, Gmail.Users.Messages.Trash, Gmail.Users.Messages.Untrash, Gmail.Users.Settings.Delegates.Create, Gmail.Users.Settings.Delegates.Delete, Gmail.Users.Settings.Delegates.Get, Gmail.Users.Settings.Delegates.List, Gmail.Users.Settings.Filters.Create, Gmail.Users.Settings.Filters.Delete, Gmail.Users.Settings.Filters.Get, Gmail.Users.Settings.Filters.List, Gmail.Users.Settings.ForwardingAddresses.Create, Gmail.Users.Settings.ForwardingAddresses.Delete, Gmail.Users.Settings.ForwardingAddresses.Get, Gmail.Users.Settings.ForwardingAddresses.List, Gmail.Users.Settings.GetAutoForwarding, Gmail.Users.Settings.GetImap, Gmail.Users.Settings.GetLanguage, Gmail.Users.Settings.GetPop, Gmail.Users.Settings.GetVacation, Gmail.Users.Settings.SendAs.Create, Gmail.Users.Settings.SendAs.Delete, Gmail.Users.Settings.SendAs.Get, Gmail.Users.Settings.SendAs.List, Gmail.Users.Settings.SendAs.Patch, Gmail.Users.Settings.SendAs.SmimeInfo.Delete, Gmail.Users.Settings.SendAs.SmimeInfo.Get, Gmail.Users.Settings.SendAs.SmimeInfo.Insert, Gmail.Users.Settings.SendAs.SmimeInfo.List, Gmail.Users.Settings.SendAs.SmimeInfo.SetDefault, Gmail.Users.Settings.SendAs.Update, Gmail.Users.Settings.SendAs.Verify, Gmail.Users.Settings.UpdateAutoForwarding, Gmail.Users.Settings.UpdateImap, Gmail.Users.Settings.UpdateLanguage, Gmail.Users.Settings.UpdatePop, Gmail.Users.Settings.UpdateVacation, Gmail.Users.Stop, Gmail.Users.Threads.Delete, Gmail.Users.Threads.Get, Gmail.Users.Threads.List, Gmail.Users.Threads.Modify, Gmail.Users.Threads.Trash, Gmail.Users.Threads.Untrash, Gmail.Users.Watch
```
public abstract class GmailRequest<T>
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
```
Gmail request.

Since:

1.3

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
Constructor and Description
`GmailRequest(Gmail client, java.lang.String method, java.lang.String uriTemplate, java.lang.Object content, java.lang.Class<T> responseClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Gmail`	`getAbstractGoogleClient()`
`java.lang.String`	`getAlt()` Data format for the response.
`java.lang.String`	`getFields()` Selector specifying which fields to include in a partial response.
`java.lang.String`	`getKey()` API key.
`java.lang.String`	`getOauthToken()` OAuth 2.0 token for the current user.
`java.lang.Boolean`	`getPrettyPrint()` Returns response with indentations and line breaks.
`java.lang.String`	`getQuotaUser()` An opaque string that represents a user for quota purposes.
`java.lang.String`	`getUserIp()` Deprecated.
`GmailRequest<T>`	`set(java.lang.String parameterName, java.lang.Object value)`
`GmailRequest<T>`	`setAlt(java.lang.String alt)` Data format for the response.
`GmailRequest<T>`	`setDisableGZipContent(boolean disableGZipContent)`
`GmailRequest<T>`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`GmailRequest<T>`	`setKey(java.lang.String key)` API key.
`GmailRequest<T>`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`GmailRequest<T>`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`GmailRequest<T>`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`GmailRequest<T>`	`setRequestHeaders(com.google.api.client.http.HttpHeaders headers)`
`GmailRequest<T>`	`setUserIp(java.lang.String userIp)` Deprecated.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
  - GmailRequest
```
public GmailRequest(Gmail client,
                    java.lang.String method,
                    java.lang.String uriTemplate,
                    java.lang.Object content,
                    java.lang.Class<T> responseClass)
```
    Parameters:
    
    client - Google client
    
    method - HTTP Method
    
    uriTemplate - URI template for the path relative to the base URL. If it starts with a "/" the base path from the base URL will be stripped out. The URI template can also be a full URL. URI template expansion is done using UriTemplate.expand(String, String, Object, boolean)
    
    content - A POJO that can be serialized into JSON or null for none
    
    responseClass - response class to parse into
- Method Detail
  - getAlt
```
public java.lang.String getAlt()
```
    Data format for the response. [default: json]
  - setAlt
```
public GmailRequest<T> setAlt(java.lang.String alt)
```
    Data format for the response.
  - getFields
```
public java.lang.String getFields()
```
    Selector specifying which fields to include in a partial response.
  - setFields
```
public GmailRequest<T> setFields(java.lang.String fields)
```
    Selector specifying which fields to include in a partial response.
  - getKey
```
public java.lang.String getKey()
```
    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.
  - setKey
```
public GmailRequest<T> setKey(java.lang.String key)
```
    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.
  - getOauthToken
```
public java.lang.String getOauthToken()
```
    OAuth 2.0 token for the current user.
  - setOauthToken
```
public GmailRequest<T> setOauthToken(java.lang.String oauthToken)
```
    OAuth 2.0 token for the current user.
  - getPrettyPrint
```
public java.lang.Boolean getPrettyPrint()
```
    Returns response with indentations and line breaks. [default: true]
  - setPrettyPrint
```
public GmailRequest<T> setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Returns response with indentations and line breaks.
  - getQuotaUser
```
public java.lang.String getQuotaUser()
```
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  - setQuotaUser
```
public GmailRequest<T> setQuotaUser(java.lang.String quotaUser)
```
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  - getUserIp
```
public java.lang.String getUserIp()
```
    Deprecated. Please use quotaUser instead.
  - setUserIp
```
public GmailRequest<T> setUserIp(java.lang.String userIp)
```
    Deprecated. Please use quotaUser instead.
  - getAbstractGoogleClient
```
public final Gmail getAbstractGoogleClient()
```
    Overrides:
    
    getAbstractGoogleClient in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
  - setDisableGZipContent
```
public GmailRequest<T> setDisableGZipContent(boolean disableGZipContent)
```
    Overrides:
    
    setDisableGZipContent in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
  - setRequestHeaders
```
public GmailRequest<T> setRequestHeaders(com.google.api.client.http.HttpHeaders headers)
```
    Overrides:
    
    setRequestHeaders in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
  - set
```
public GmailRequest<T> set(java.lang.String parameterName,
                           java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

Gmail API v1 (revision 110)

Class GmailRequest<T>

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.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

GmailRequest

Method Detail

getAlt

setAlt

getFields

setFields

getKey

setKey

getOauthToken

setOauthToken

getPrettyPrint

setPrettyPrint

getQuotaUser

setQuotaUser

getUserIp

setUserIp

getAbstractGoogleClient

setDisableGZipContent

setRequestHeaders

set