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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenerateIds() Generates a set of file IDs which can be provided in insert 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	getMaxResults() Maximum number of IDs to return.
String	getSpace() The space in which the IDs can be used to create new 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	setAlt(String alt) Data format for the response.
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	setMaxResults(Integer maxResults) Maximum number of IDs to return.
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) An opaque string that represents a user for quota purposes.
Drive.Files.GenerateIds	setSpace(String space) The space in which the IDs can be used to create new files.
Drive.Files.GenerateIds	setType(String type) The type of items which the IDs can be used for.
Drive.Files.GenerateIds	setUserIp(String userIp) Deprecated.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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 insert or copy requests. 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

setAlt

public Drive.Files.GenerateIds setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt 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

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DriveRequest<GeneratedIds>

setUserIp

public Drive.Files.GenerateIds setUserIp(String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<GeneratedIds>

getMaxResults

public Integer getMaxResults()

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

setMaxResults

public Drive.Files.GenerateIds setMaxResults(Integer maxResults)

Maximum number of IDs to return.

getSpace

public String getSpace()

The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive') [default: drive]

setSpace

public Drive.Files.GenerateIds setSpace(String space)

The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive')

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') [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')

set

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

Overrides:

set in class DriveRequest<GeneratedIds>