public class Drive.Files.Patch extends DriveRequest<File>
com.google.api.client.util.GenericData.Flags
Modifier | Constructor and Description |
---|---|
protected |
Patch(java.lang.String fileId,
File content)
Updates file metadata and/or content.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAddParents()
Comma-separated list of parent IDs to add.
|
java.lang.Boolean |
getConvert()
This parameter is deprecated and has no function.
|
java.lang.Boolean |
getEnforceSingleParent()
Set to true to opt in to API behavior that aims for all items to have exactly one parent.
|
java.lang.String |
getFileId()
The ID of the file to update.
|
java.lang.String |
getModifiedDateBehavior()
Determines the behavior in which modifiedDate is updated.
|
java.lang.Boolean |
getNewRevision()
Whether a blob upload should create a new revision.
|
java.lang.Boolean |
getOcr()
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
|
java.lang.String |
getOcrLanguage()
If ocr is true, hints at the language to use.
|
java.lang.Boolean |
getPinned()
Whether to pin the new revision.
|
java.lang.String |
getRemoveParents()
Comma-separated list of parent IDs to remove.
|
java.lang.Boolean |
getSetModifiedDate()
Whether to set the modified date using the value supplied in the request body.
|
java.lang.Boolean |
getSupportsAllDrives()
Deprecated - Whether the requesting application supports both My Drives and shared drives.
|
java.lang.Boolean |
getSupportsTeamDrives()
Deprecated use supportsAllDrives instead.
|
java.lang.String |
getTimedTextLanguage()
The language of the timed text.
|
java.lang.String |
getTimedTextTrackName()
The timed text track name.
|
java.lang.Boolean |
getUpdateViewedDate()
Whether to update the view date after successfully updating the file.
|
java.lang.Boolean |
getUseContentAsIndexableText()
Whether to use the content as indexable text.
|
boolean |
isConvert()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isEnforceSingleParent()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isNewRevision()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isOcr()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isPinned()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isSetModifiedDate()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isSupportsAllDrives()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isSupportsTeamDrives()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isUpdateViewedDate()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isUseContentAsIndexableText()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
Drive.Files.Patch |
set(java.lang.String parameterName,
java.lang.Object value) |
Drive.Files.Patch |
setAddParents(java.lang.String addParents)
Comma-separated list of parent IDs to add.
|
Drive.Files.Patch |
setAlt(java.lang.String alt)
Data format for the response.
|
Drive.Files.Patch |
setConvert(java.lang.Boolean convert)
This parameter is deprecated and has no function.
|
Drive.Files.Patch |
setEnforceSingleParent(java.lang.Boolean enforceSingleParent)
Set to true to opt in to API behavior that aims for all items to have exactly one parent.
|
Drive.Files.Patch |
setFields(java.lang.String fields)
Selector specifying which fields to include in a partial response.
|
Drive.Files.Patch |
setFileId(java.lang.String fileId)
The ID of the file to update.
|
Drive.Files.Patch |
setKey(java.lang.String key)
API key.
|
Drive.Files.Patch |
setModifiedDateBehavior(java.lang.String modifiedDateBehavior)
Determines the behavior in which modifiedDate is updated.
|
Drive.Files.Patch |
setNewRevision(java.lang.Boolean newRevision)
Whether a blob upload should create a new revision.
|
Drive.Files.Patch |
setOauthToken(java.lang.String oauthToken)
OAuth 2.0 token for the current user.
|
Drive.Files.Patch |
setOcr(java.lang.Boolean ocr)
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
|
Drive.Files.Patch |
setOcrLanguage(java.lang.String ocrLanguage)
If ocr is true, hints at the language to use.
|
Drive.Files.Patch |
setPinned(java.lang.Boolean pinned)
Whether to pin the new revision.
|
Drive.Files.Patch |
setPrettyPrint(java.lang.Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Drive.Files.Patch |
setQuotaUser(java.lang.String quotaUser)
An opaque string that represents a user for quota purposes.
|
Drive.Files.Patch |
setRemoveParents(java.lang.String removeParents)
Comma-separated list of parent IDs to remove.
|
Drive.Files.Patch |
setSetModifiedDate(java.lang.Boolean setModifiedDate)
Whether to set the modified date using the value supplied in the request body.
|
Drive.Files.Patch |
setSupportsAllDrives(java.lang.Boolean supportsAllDrives)
Deprecated - Whether the requesting application supports both My Drives and shared drives.
|
Drive.Files.Patch |
setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)
Deprecated use supportsAllDrives instead.
|
Drive.Files.Patch |
setTimedTextLanguage(java.lang.String timedTextLanguage)
The language of the timed text.
|
Drive.Files.Patch |
setTimedTextTrackName(java.lang.String timedTextTrackName)
The timed text track name.
|
Drive.Files.Patch |
setUpdateViewedDate(java.lang.Boolean updateViewedDate)
Whether to update the view date after successfully updating the file.
|
Drive.Files.Patch |
setUseContentAsIndexableText(java.lang.Boolean useContentAsIndexableText)
Whether to use the content as indexable text.
|
Drive.Files.Patch |
setUserIp(java.lang.String userIp)
Deprecated.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders
getJsonContent, newExceptionOnError, queue
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
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
protected Patch(java.lang.String fileId, File content)
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.
fileId
- The ID of the file to update.content
- the File
public Drive.Files.Patch setAlt(java.lang.String alt)
DriveRequest
setAlt
in class DriveRequest<File>
public Drive.Files.Patch setFields(java.lang.String fields)
DriveRequest
setFields
in class DriveRequest<File>
public Drive.Files.Patch setKey(java.lang.String key)
DriveRequest
setKey
in class DriveRequest<File>
public Drive.Files.Patch setOauthToken(java.lang.String oauthToken)
DriveRequest
setOauthToken
in class DriveRequest<File>
public Drive.Files.Patch setPrettyPrint(java.lang.Boolean prettyPrint)
DriveRequest
setPrettyPrint
in class DriveRequest<File>
public Drive.Files.Patch setQuotaUser(java.lang.String quotaUser)
DriveRequest
setQuotaUser
in class DriveRequest<File>
public Drive.Files.Patch setUserIp(java.lang.String userIp)
DriveRequest
setUserIp
in class DriveRequest<File>
public java.lang.String getFileId()
public Drive.Files.Patch setFileId(java.lang.String fileId)
public java.lang.String getAddParents()
public Drive.Files.Patch setAddParents(java.lang.String addParents)
public java.lang.Boolean getConvert()
public Drive.Files.Patch setConvert(java.lang.Boolean convert)
public boolean isConvert()
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
.
This parameter is deprecated and has no function.
public java.lang.Boolean getEnforceSingleParent()
public Drive.Files.Patch setEnforceSingleParent(java.lang.Boolean enforceSingleParent)
public boolean isEnforceSingleParent()
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
.
Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
public java.lang.String getModifiedDateBehavior()
public Drive.Files.Patch setModifiedDateBehavior(java.lang.String modifiedDateBehavior)
public java.lang.Boolean getNewRevision()
public Drive.Files.Patch setNewRevision(java.lang.Boolean newRevision)
public boolean isNewRevision()
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 false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
public java.lang.Boolean getOcr()
public Drive.Files.Patch setOcr(java.lang.Boolean ocr)
public boolean isOcr()
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 attempt OCR on .jpg, .png, .gif, or .pdf uploads.
public java.lang.String getOcrLanguage()
public Drive.Files.Patch setOcrLanguage(java.lang.String ocrLanguage)
public java.lang.Boolean getPinned()
public Drive.Files.Patch setPinned(java.lang.Boolean pinned)
public boolean isPinned()
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 pin the new revision. A file can have a maximum of 200 pinned revisions.
public java.lang.String getRemoveParents()
public Drive.Files.Patch setRemoveParents(java.lang.String removeParents)
public java.lang.Boolean getSetModifiedDate()
public Drive.Files.Patch setSetModifiedDate(java.lang.Boolean setModifiedDate)
public boolean isSetModifiedDate()
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 modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
public java.lang.Boolean getSupportsAllDrives()
public Drive.Files.Patch setSupportsAllDrives(java.lang.Boolean supportsAllDrives)
public boolean isSupportsAllDrives()
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
.
Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
public java.lang.Boolean getSupportsTeamDrives()
public Drive.Files.Patch setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)
public boolean isSupportsTeamDrives()
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
.
Deprecated use supportsAllDrives instead.
public java.lang.String getTimedTextLanguage()
public Drive.Files.Patch setTimedTextLanguage(java.lang.String timedTextLanguage)
public java.lang.String getTimedTextTrackName()
public Drive.Files.Patch setTimedTextTrackName(java.lang.String timedTextTrackName)
public java.lang.Boolean getUpdateViewedDate()
public Drive.Files.Patch setUpdateViewedDate(java.lang.Boolean updateViewedDate)
public boolean isUpdateViewedDate()
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.
public java.lang.Boolean getUseContentAsIndexableText()
public Drive.Files.Patch setUseContentAsIndexableText(java.lang.Boolean useContentAsIndexableText)
public boolean isUseContentAsIndexableText()
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 content as indexable text.
public Drive.Files.Patch set(java.lang.String parameterName, java.lang.Object value)
set
in class DriveRequest<File>