com.google.api.services.drive

Class Drive.Files.Update

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.Update
extends DriveRequest<File>

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>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Drive.Files.Update(String fileId, File content) Updates a file's metadata and/or content with patch semantics.
protected	Drive.Files.Update(String fileId, File content, AbstractInputStreamContent mediaContent) Updates a file's metadata and/or content with patch semantics.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAddParents() A comma-separated list of parent IDs to add.
String	getFileId() The ID of the file.
Boolean	getKeepRevisionForever() Whether to set the 'keepForever' field in the new head revision.
String	getOcrLanguage() A language hint for OCR processing during image import (ISO 639-1 code).
String	getRemoveParents() A comma-separated list of parent IDs to remove.
Boolean	getSupportsTeamDrives() Whether the requesting application supports Team Drives.
Boolean	getUseContentAsIndexableText() Whether to use the uploaded content as indexable text.
boolean	isKeepRevisionForever() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsTeamDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isUseContentAsIndexableText() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Files.Update	set(String parameterName, Object value)
Drive.Files.Update	setAddParents(String addParents) A comma-separated list of parent IDs to add.
Drive.Files.Update	setAlt(String alt) Data format for the response.
Drive.Files.Update	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Update	setFileId(String fileId) The ID of the file.
Drive.Files.Update	setKeepRevisionForever(Boolean keepRevisionForever) Whether to set the 'keepForever' field in the new head revision.
Drive.Files.Update	setKey(String key) API key.
Drive.Files.Update	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Update	setOcrLanguage(String ocrLanguage) A language hint for OCR processing during image import (ISO 639-1 code).
Drive.Files.Update	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Update	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Files.Update	setRemoveParents(String removeParents) A comma-separated list of parent IDs to remove.
Drive.Files.Update	setSupportsTeamDrives(Boolean supportsTeamDrives) Whether the requesting application supports Team Drives.
Drive.Files.Update	setUseContentAsIndexableText(Boolean useContentAsIndexableText) Whether to use the uploaded content as indexable text.
Drive.Files.Update	setUserIp(String userIp) IP address of the site where the request originates.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Drive.Files.Update

protected Drive.Files.Update(String fileId,
                  File content)

Updates a file's metadata and/or content with patch semantics. Create a request for the method "files.update". 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.

Parameters:

fileId - The ID of the file.

content - the File

Since:

1.13

Drive.Files.Update

protected Drive.Files.Update(String fileId,
                  File content,
                  AbstractInputStreamContent mediaContent)

Updates a file's metadata and/or content with patch semantics. Create a request for the method "files.update". 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.

This constructor should be used for uploading media content.

Parameters:

fileId - The ID of the file.

content - the File media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

public Drive.Files.Update setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<File>

setFields

public Drive.Files.Update setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<File>

setKey

public Drive.Files.Update 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<File>

setOauthToken

public Drive.Files.Update setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<File>

setPrettyPrint

public Drive.Files.Update setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<File>

setQuotaUser

public Drive.Files.Update 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 userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<File>

setUserIp

public Drive.Files.Update setUserIp(String userIp)

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<File>

getFileId

public String getFileId()

The ID of the file.

setFileId

public Drive.Files.Update setFileId(String fileId)

The ID of the file.

getAddParents

public String getAddParents()

A comma-separated list of parent IDs to add.

setAddParents

public Drive.Files.Update setAddParents(String addParents)

A comma-separated list of parent IDs to add.

getKeepRevisionForever

public Boolean getKeepRevisionForever()

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive. [default: false]

setKeepRevisionForever

public Drive.Files.Update setKeepRevisionForever(Boolean keepRevisionForever)

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.

isKeepRevisionForever

public boolean isKeepRevisionForever()

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.

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.

getOcrLanguage

public String getOcrLanguage()

A language hint for OCR processing during image import (ISO 639-1 code).

setOcrLanguage

public Drive.Files.Update setOcrLanguage(String ocrLanguage)

A language hint for OCR processing during image import (ISO 639-1 code).

getRemoveParents

public String getRemoveParents()

A comma-separated list of parent IDs to remove.

setRemoveParents

public Drive.Files.Update setRemoveParents(String removeParents)

A comma-separated list of parent IDs to remove.

getSupportsTeamDrives

public Boolean getSupportsTeamDrives()

Whether the requesting application supports Team Drives. [default: false]

setSupportsTeamDrives

public Drive.Files.Update setSupportsTeamDrives(Boolean supportsTeamDrives)

Whether the requesting application supports Team Drives.

isSupportsTeamDrives

public boolean isSupportsTeamDrives()

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.

Whether the requesting application supports Team Drives.

getUseContentAsIndexableText

public Boolean getUseContentAsIndexableText()

Whether to use the uploaded content as indexable text. [default: false]

setUseContentAsIndexableText

public Drive.Files.Update setUseContentAsIndexableText(Boolean useContentAsIndexableText)

Whether to use the uploaded content as indexable text.

isUseContentAsIndexableText

public boolean isUseContentAsIndexableText()

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.

Whether to use the uploaded content as indexable text.

set

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

Overrides:

set in class DriveRequest<File>