Drive API v1 (revision 55)



com.google.api.services.drive
Class Drive.Files.Patch

java.lang.Object
  extended by java.util.AbstractMap<String,Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
              extended by com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  extended by com.google.api.services.drive.DriveRequest<File>
                      extended by com.google.api.services.drive.Drive.Files.Patch
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
Drive.Files

public class Drive.Files.Patch
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
protected Drive.Files.Patch(String id, File content)
          Updates file metadata and/or content.
 
Method Summary
 String getId()
          The id for the file in question.
 Boolean getNewRevision()
          Whether a blob upload should create a new revision.
 Boolean getUpdateModifiedDate()
          Controls updating the modified date of the file.
 Boolean getUpdateViewedDate()
          Whether to update the view date after successfully updating the file.
 boolean isNewRevision()
          Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
 boolean isUpdateModifiedDate()
          Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
 boolean isUpdateViewedDate()
          Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
 Drive.Files.Patch setAlt(String alt)
          Data format for the response.
 Drive.Files.Patch setFields(String fields)
          Selector specifying which fields to include in a partial response.
 Drive.Files.Patch setId(String id)
          The id for the file in question.
 Drive.Files.Patch setKey(String key)
          API key.
 Drive.Files.Patch setNewRevision(Boolean newRevision)
          Whether a blob upload should create a new revision.
 Drive.Files.Patch setOauthToken(String oauthToken)
          OAuth 2.0 token for the current user.
 Drive.Files.Patch setPrettyPrint(Boolean prettyPrint)
          Returns response with indentations and line breaks.
 Drive.Files.Patch setQuotaUser(String quotaUser)
          Available to use for quota purposes for server-side applications.
 Drive.Files.Patch setUpdateModifiedDate(Boolean updateModifiedDate)
          Controls updating the modified date of the file.
 Drive.Files.Patch setUpdateViewedDate(Boolean updateViewedDate)
          Whether to update the view date after successfully updating the file.
 Drive.Files.Patch 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, 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, set, 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.Patch

protected Drive.Files.Patch(String id,
                            File content)
Updates file metadata and/or content. This method supports patch semantics. Create a request for the method "files.patch". 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(AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:
id - The id for the file in question.
content - the File
Since:
1.13
Method Detail

setAlt

public Drive.Files.Patch setAlt(String alt)
Description copied from class: DriveRequest
Data format for the response.

Overrides:
setAlt in class DriveRequest<File>

setFields

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

getId

public String getId()
The id for the file in question.


setId

public Drive.Files.Patch setId(String id)
The id for the file in question.


getUpdateViewedDate

public Boolean getUpdateViewedDate()
Whether to update the view date after successfully updating the file. [default: true]


setUpdateViewedDate

public Drive.Files.Patch setUpdateViewedDate(Boolean updateViewedDate)
Whether to update the view date after successfully updating the file.


isUpdateViewedDate

public boolean isUpdateViewedDate()
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 update the view date after successfully updating the file.


getUpdateModifiedDate

public Boolean getUpdateModifiedDate()
Controls updating the modified date of the file. If true, the modified date will be updated to the current time, regardless of whether other changes are being made. If false, the modified date will only be updated to the current time if other changes are also being made (changing the title, for example). [default: false]


setUpdateModifiedDate

public Drive.Files.Patch setUpdateModifiedDate(Boolean updateModifiedDate)
Controls updating the modified date of the file. If true, the modified date will be updated to the current time, regardless of whether other changes are being made. If false, the modified date will only be updated to the current time if other changes are also being made (changing the title, for example).


isUpdateModifiedDate

public boolean isUpdateModifiedDate()
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.

Controls updating the modified date of the file. If true, the modified date will be updated to the current time, regardless of whether other changes are being made. If false, the modified date will only be updated to the current time if other changes are also being made (changing the title, for example).


getNewRevision

public Boolean getNewRevision()
Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision will be replaced. [default: true]


setNewRevision

public Drive.Files.Patch setNewRevision(Boolean newRevision)
Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision will be replaced.


isNewRevision

public boolean isNewRevision()
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 a blob upload should create a new revision. If not set or false, the blob data in the current head revision will be replaced.