target.apidocs.com.google.api.services.gmail.Gmail.Users.Threads.Get.html Maven / Gradle / Ivy
Gmail.Users.Threads.Get (Gmail API v1-rev20240422-2.0.0)
com.google.api.services.gmail
Class Gmail.Users.Threads.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<Thread>
-
- com.google.api.services.gmail.Gmail.Users.Threads.Get
-
- Enclosing class:
- Gmail.Users.Threads
public class Gmail.Users.Threads.Get
extends GmailRequest<Thread>
-
-
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 id)
Gets the specified thread.
-
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()
String
getFormat()
The format to return the messages in.
String
getId()
The ID of the thread to retrieve.
List<String>
getMetadataHeaders()
When given and format is METADATA, only include headers specified.
Boolean
getTemporaryEeccBypass()
[ default: false]
[
String
getUserId()
The user's email address.
boolean
isTemporaryEeccBypass()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
Gmail.Users.Threads.Get
set(String parameterName,
Object value)
Gmail.Users.Threads.Get
set$Xgafv(String $Xgafv)
V1 error format.
Gmail.Users.Threads.Get
setAccessToken(String accessToken)
OAuth access token.
Gmail.Users.Threads.Get
setAlt(String alt)
Data format for response.
Gmail.Users.Threads.Get
setCallback(String callback)
JSONP
Gmail.Users.Threads.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.
Gmail.Users.Threads.Get
setFormat(String format)
The format to return the messages in.
Gmail.Users.Threads.Get
setId(String id)
The ID of the thread to retrieve.
Gmail.Users.Threads.Get
setKey(String key)
API key.
Gmail.Users.Threads.Get
setMetadataHeaders(List<String> metadataHeaders)
When given and format is METADATA, only include headers specified.
Gmail.Users.Threads.Get
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Gmail.Users.Threads.Get
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Gmail.Users.Threads.Get
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Gmail.Users.Threads.Get
setTemporaryEeccBypass(Boolean temporaryEeccBypass)
Gmail.Users.Threads.Get
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Gmail.Users.Threads.Get
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Gmail.Users.Threads.Get
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
-
Get
protected Get(String userId,
String id)
Gets the specified thread.
Create a request for the method "threads.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
- The user's email address. The special value `me` can be used to indicate the authenticated user.
[default: me]
id
- The ID of the thread to retrieve.
- 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<Thread>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Thread>
- Throws:
IOException
-
set$Xgafv
public Gmail.Users.Threads.Get set$Xgafv(String $Xgafv)
Description copied from class: GmailRequest
V1 error format.
- Overrides:
set$Xgafv
in class GmailRequest<Thread>
-
setAccessToken
public Gmail.Users.Threads.Get setAccessToken(String accessToken)
Description copied from class: GmailRequest
OAuth access token.
- Overrides:
setAccessToken
in class GmailRequest<Thread>
-
setAlt
public Gmail.Users.Threads.Get setAlt(String alt)
Description copied from class: GmailRequest
Data format for response.
- Overrides:
setAlt
in class GmailRequest<Thread>
-
setCallback
public Gmail.Users.Threads.Get setCallback(String callback)
Description copied from class: GmailRequest
JSONP
- Overrides:
setCallback
in class GmailRequest<Thread>
-
setFields
public Gmail.Users.Threads.Get setFields(String fields)
Description copied from class: GmailRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class GmailRequest<Thread>
-
setKey
public Gmail.Users.Threads.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<Thread>
-
setOauthToken
public Gmail.Users.Threads.Get setOauthToken(String oauthToken)
Description copied from class: GmailRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class GmailRequest<Thread>
-
setPrettyPrint
public Gmail.Users.Threads.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: GmailRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class GmailRequest<Thread>
-
setQuotaUser
public Gmail.Users.Threads.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<Thread>
-
setUploadType
public Gmail.Users.Threads.Get setUploadType(String uploadType)
Description copied from class: GmailRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class GmailRequest<Thread>
-
setUploadProtocol
public Gmail.Users.Threads.Get setUploadProtocol(String uploadProtocol)
Description copied from class: GmailRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class GmailRequest<Thread>
-
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.Threads.Get setUserId(String userId)
The user's email address. The special value `me` can be used to indicate the
authenticated user.
-
getId
public String getId()
The ID of the thread to retrieve.
-
setId
public Gmail.Users.Threads.Get setId(String id)
The ID of the thread to retrieve.
-
getFormat
public String getFormat()
The format to return the messages in. [default: full]
-
setFormat
public Gmail.Users.Threads.Get setFormat(String format)
The format to return the messages in.
-
getMetadataHeaders
public List<String> getMetadataHeaders()
When given and format is METADATA, only include headers specified.
-
setMetadataHeaders
public Gmail.Users.Threads.Get setMetadataHeaders(List<String> metadataHeaders)
When given and format is METADATA, only include headers specified.
-
getTemporaryEeccBypass
public Boolean getTemporaryEeccBypass()
[ default: false]
[
-
setTemporaryEeccBypass
public Gmail.Users.Threads.Get setTemporaryEeccBypass(Boolean temporaryEeccBypass)
-
isTemporaryEeccBypass
public boolean isTemporaryEeccBypass()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
-
set
public Gmail.Users.Threads.Get set(String parameterName,
Object value)
- Overrides:
set
in class GmailRequest<Thread>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy