com.google.api.services.drive

Class Drive.Files.GenerateIds

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.drive.DriveRequest<GeneratedIds>

com.google.api.services.drive.Drive.Files.GenerateIds

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.GenerateIds
extends DriveRequest<GeneratedIds>

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	GenerateIds() Generates a set of file IDs which can be provided in create or copy requests.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getCount() The number of IDs to return.
String	getSpace() The space in which the IDs can be used to create files.
String	getType() The type of items which the IDs can be used for.
Drive.Files.GenerateIds	set(String parameterName, Object value)
Drive.Files.GenerateIds	set$Xgafv(String $Xgafv) V1 error format.
Drive.Files.GenerateIds	setAccessToken(String accessToken) OAuth access token.
Drive.Files.GenerateIds	setAlt(String alt) Data format for response.
Drive.Files.GenerateIds	setCallback(String callback) JSONP
Drive.Files.GenerateIds	setCount(Integer count) The number of IDs to return.
Drive.Files.GenerateIds	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.GenerateIds	setKey(String key) API key.
Drive.Files.GenerateIds	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.GenerateIds	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.GenerateIds	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Files.GenerateIds	setSpace(String space) The space in which the IDs can be used to create files.
Drive.Files.GenerateIds	setType(String type) The type of items which the IDs can be used for.
Drive.Files.GenerateIds	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Drive.Files.GenerateIds	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.drive.DriveRequest

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

GenerateIds

protected GenerateIds()

Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). Create a request for the method "files.generateIds". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

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

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GeneratedIds>

Throws:

IOException

set$Xgafv

public Drive.Files.GenerateIds set$Xgafv(String $Xgafv)

Description copied from class: DriveRequest

V1 error format.

Overrides:

set$Xgafv in class DriveRequest<GeneratedIds>

setAccessToken

public Drive.Files.GenerateIds setAccessToken(String accessToken)

Description copied from class: DriveRequest

OAuth access token.

Overrides:

setAccessToken in class DriveRequest<GeneratedIds>

setAlt

public Drive.Files.GenerateIds setAlt(String alt)

Description copied from class: DriveRequest

Data format for response.

Overrides:

setAlt in class DriveRequest<GeneratedIds>

setCallback

public Drive.Files.GenerateIds setCallback(String callback)

Description copied from class: DriveRequest

JSONP

Overrides:

setCallback in class DriveRequest<GeneratedIds>

setFields

public Drive.Files.GenerateIds setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<GeneratedIds>

setKey

public Drive.Files.GenerateIds setKey(String key)

Description copied from class: DriveRequest

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 DriveRequest<GeneratedIds>

setOauthToken

public Drive.Files.GenerateIds setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<GeneratedIds>

setPrettyPrint

public Drive.Files.GenerateIds setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<GeneratedIds>

setQuotaUser

public Drive.Files.GenerateIds setQuotaUser(String quotaUser)

Description copied from class: DriveRequest

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 DriveRequest<GeneratedIds>

setUploadType

public Drive.Files.GenerateIds setUploadType(String uploadType)

Description copied from class: DriveRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DriveRequest<GeneratedIds>

setUploadProtocol

public Drive.Files.GenerateIds setUploadProtocol(String uploadProtocol)

Description copied from class: DriveRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DriveRequest<GeneratedIds>

getCount

public Integer getCount()

The number of IDs to return. [default: 10] [minimum: 1] [maximum: 1000]

setCount

public Drive.Files.GenerateIds setCount(Integer count)

The number of IDs to return.

getSpace

public String getSpace()

The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file- organization). [default: drive]

setSpace

public Drive.Files.GenerateIds setSpace(String space)

The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file- organization).

getType

public String getType()

The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file- organization). [default: files]

setType

public Drive.Files.GenerateIds setType(String type)

The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file- organization).

set

public Drive.Files.GenerateIds set(String parameterName,
                                   Object value)

Overrides:

set in class DriveRequest<GeneratedIds>