target.apidocs.com.google.api.services.gmail.Gmail.Users.Settings.ForwardingAddresses.Get.html Maven / Gradle / Ivy
Gmail.Users.Settings.ForwardingAddresses.Get (Gmail API v1-rev20240422-2.0.0)
com.google.api.services.gmail
Class Gmail.Users.Settings.ForwardingAddresses.Get
- 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<ForwardingAddress>
-
- com.google.api.services.gmail.Gmail.Users.Settings.ForwardingAddresses.Get
-
- Enclosing class:
- Gmail.Users.Settings.ForwardingAddresses
public class Gmail.Users.Settings.ForwardingAddresses.Get
extends GmailRequest<ForwardingAddress>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Get(String userId,
String forwardingEmail)
Gets the specified forwarding address.
-
Method Summary
-
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
-
Get
protected Get(String userId,
String forwardingEmail)
Gets the specified forwarding address.
Create a request for the method "forwardingAddresses.get".
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
- User's email address. The special value "me" can be used to indicate the authenticated user.
[default: me]
forwardingEmail
- The forwarding address to be retrieved.
- 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<ForwardingAddress>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ForwardingAddress>
- Throws:
IOException
-
set$Xgafv
public Gmail.Users.Settings.ForwardingAddresses.Get set$Xgafv(String $Xgafv)
Description copied from class: GmailRequest
V1 error format.
- Overrides:
set$Xgafv
in class GmailRequest<ForwardingAddress>
-
setAccessToken
public Gmail.Users.Settings.ForwardingAddresses.Get setAccessToken(String accessToken)
Description copied from class: GmailRequest
OAuth access token.
- Overrides:
setAccessToken
in class GmailRequest<ForwardingAddress>
-
setAlt
public Gmail.Users.Settings.ForwardingAddresses.Get setAlt(String alt)
Description copied from class: GmailRequest
Data format for response.
- Overrides:
setAlt
in class GmailRequest<ForwardingAddress>
-
setCallback
public Gmail.Users.Settings.ForwardingAddresses.Get setCallback(String callback)
Description copied from class: GmailRequest
JSONP
- Overrides:
setCallback
in class GmailRequest<ForwardingAddress>
-
setFields
public Gmail.Users.Settings.ForwardingAddresses.Get setFields(String fields)
Description copied from class: GmailRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class GmailRequest<ForwardingAddress>
-
setKey
public Gmail.Users.Settings.ForwardingAddresses.Get 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<ForwardingAddress>
-
setOauthToken
public Gmail.Users.Settings.ForwardingAddresses.Get setOauthToken(String oauthToken)
Description copied from class: GmailRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class GmailRequest<ForwardingAddress>
-
setPrettyPrint
public Gmail.Users.Settings.ForwardingAddresses.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: GmailRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class GmailRequest<ForwardingAddress>
-
setQuotaUser
public Gmail.Users.Settings.ForwardingAddresses.Get 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<ForwardingAddress>
-
setUploadType
public Gmail.Users.Settings.ForwardingAddresses.Get setUploadType(String uploadType)
Description copied from class: GmailRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class GmailRequest<ForwardingAddress>
-
setUploadProtocol
public Gmail.Users.Settings.ForwardingAddresses.Get setUploadProtocol(String uploadProtocol)
Description copied from class: GmailRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class GmailRequest<ForwardingAddress>
-
getUserId
public String getUserId()
User's email address. The special value "me" can be used to indicate the authenticated user.
[default: me]
-
setUserId
public Gmail.Users.Settings.ForwardingAddresses.Get setUserId(String userId)
User's email address. The special value "me" can be used to indicate the authenticated
user.
-
getForwardingEmail
public String getForwardingEmail()
The forwarding address to be retrieved.
-
setForwardingEmail
public Gmail.Users.Settings.ForwardingAddresses.Get setForwardingEmail(String forwardingEmail)
The forwarding address to be retrieved.
-
set
public Gmail.Users.Settings.ForwardingAddresses.Get set(String parameterName,
Object value)
- Overrides:
set
in class GmailRequest<ForwardingAddress>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy