target.apidocs.com.google.api.services.docs.v1.Docs.Documents.Get.html Maven / Gradle / Ivy
Docs.Documents.Get (Google Docs API v1-rev20220520-1.32.1)
com.google.api.services.docs.v1
Class Docs.Documents.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.docs.v1.DocsRequest<Document>
-
- com.google.api.services.docs.v1.Docs.Documents.Get
-
- Enclosing class:
- Docs.Documents
public class Docs.Documents.Get
extends DocsRequest<Document>
-
-
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>
-
Field Summary
-
Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Get(String documentId)
Gets the latest version of the specified document.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
HttpRequest
buildHttpRequestUsingHead()
HttpResponse
executeUsingHead()
String
getDocumentId()
The ID of the document to retrieve.
String
getSuggestionsViewMode()
The suggestions view mode to apply to the document.
Docs.Documents.Get
set(String parameterName,
Object value)
Docs.Documents.Get
set$Xgafv(String $Xgafv)
V1 error format.
Docs.Documents.Get
setAccessToken(String accessToken)
OAuth access token.
Docs.Documents.Get
setAlt(String alt)
Data format for response.
Docs.Documents.Get
setCallback(String callback)
JSONP
Docs.Documents.Get
setDocumentId(String documentId)
The ID of the document to retrieve.
Docs.Documents.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.
Docs.Documents.Get
setKey(String key)
API key.
Docs.Documents.Get
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Docs.Documents.Get
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Docs.Documents.Get
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Docs.Documents.Get
setSuggestionsViewMode(String suggestionsViewMode)
The suggestions view mode to apply to the document.
Docs.Documents.Get
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Docs.Documents.Get
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.docs.v1.DocsRequest
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 documentId)
Gets the latest version of the specified document.
Create a request for the method "documents.get".
This request holds the parameters needed by the the docs server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation. Docs.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be
called to initialize this instance immediately after invoking the constructor.
- Parameters:
documentId
- The ID of the document to retrieve.
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class AbstractGoogleClientRequest<Document>
- Throws:
IOException
-
buildHttpRequestUsingHead
public HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class AbstractGoogleClientRequest<Document>
- Throws:
IOException
-
set$Xgafv
public Docs.Documents.Get set$Xgafv(String $Xgafv)
Description copied from class: DocsRequest
V1 error format.
- Overrides:
set$Xgafv
in class DocsRequest<Document>
-
setAccessToken
public Docs.Documents.Get setAccessToken(String accessToken)
Description copied from class: DocsRequest
OAuth access token.
- Overrides:
setAccessToken
in class DocsRequest<Document>
-
setAlt
public Docs.Documents.Get setAlt(String alt)
Description copied from class: DocsRequest
Data format for response.
- Overrides:
setAlt
in class DocsRequest<Document>
-
setCallback
public Docs.Documents.Get setCallback(String callback)
Description copied from class: DocsRequest
JSONP
- Overrides:
setCallback
in class DocsRequest<Document>
-
setFields
public Docs.Documents.Get setFields(String fields)
Description copied from class: DocsRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class DocsRequest<Document>
-
setKey
public Docs.Documents.Get setKey(String key)
Description copied from class: DocsRequest
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 DocsRequest<Document>
-
setOauthToken
public Docs.Documents.Get setOauthToken(String oauthToken)
Description copied from class: DocsRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class DocsRequest<Document>
-
setPrettyPrint
public Docs.Documents.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: DocsRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class DocsRequest<Document>
-
setQuotaUser
public Docs.Documents.Get setQuotaUser(String quotaUser)
Description copied from class: DocsRequest
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 DocsRequest<Document>
-
setUploadType
public Docs.Documents.Get setUploadType(String uploadType)
Description copied from class: DocsRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class DocsRequest<Document>
-
setUploadProtocol
public Docs.Documents.Get setUploadProtocol(String uploadProtocol)
Description copied from class: DocsRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class DocsRequest<Document>
-
getDocumentId
public String getDocumentId()
The ID of the document to retrieve.
-
setDocumentId
public Docs.Documents.Get setDocumentId(String documentId)
The ID of the document to retrieve.
-
getSuggestionsViewMode
public String getSuggestionsViewMode()
The suggestions view mode to apply to the document. This allows viewing the document with all
suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is
used.
-
setSuggestionsViewMode
public Docs.Documents.Get setSuggestionsViewMode(String suggestionsViewMode)
The suggestions view mode to apply to the document. This allows viewing the document with
all suggestions inline, accepted or rejected. If one is not specified,
DEFAULT_FOR_CURRENT_ACCESS is used.
-
set
public Docs.Documents.Get set(String parameterName,
Object value)
- Overrides:
set
in class DocsRequest<Document>
Copyright © 2011–2022 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy