All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.drive.Drive.Files.Patch.html Maven / Gradle / Ivy

Go to download

There is a newer version: v3-rev20241027-2.0.0
Show newest version






Drive.Files.Patch (Google Drive API v2-rev20240809-2.0.0)













Skip navigation links
































com.google.api.services.drive


Class Drive.Files.Patch



















    

  • 


      

    • 



      Constructor Detail
      




        

      • 

        Patch
        

        protected Patch(String fileId,
                File content)
        

        Updates a file's metadata and/or content. When calling this method, only populate fields in the
 request that you want to modify. When updating fields, some fields might change automatically,
 such as modifiedDate. 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(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 to update.
        

        content - the File
        

        Since:
        

        1.13
        

        

        • 

      

      • 

    


      

    • 



      Method Detail
      
























        

      • 

        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>
        

        

        • 

      












        

      • 

        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:
        

        setQuotaUser in class DriveRequest<File>
        

        

        • 

      












        

      • 

        getFileId
        

        public String getFileId()
        

        The ID of the file to update.
        

        • 

      








        

      • 

        getAddParents
        

        public String getAddParents()
        

        Comma-separated list of parent IDs to add.
        

        • 

      




        

      • 

        setAddParents
        

        public Drive.Files.Patch setAddParents(String addParents)
        

        Comma-separated list of parent IDs to add.
        

        • 

      




        

      • 

        getConvert
        

        public Boolean getConvert()
        

        Deprecated: This parameter has no function. [default: false]
        

        • 

      












        

      • 

        getEnforceSingleParent
        

        public Boolean getEnforceSingleParent()
        

        Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.
     [default: false]
        

        • 

      




        

      • 

        setEnforceSingleParent
        

        public Drive.Files.Patch setEnforceSingleParent(Boolean enforceSingleParent)
        

        Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts`
 instead.
        

        • 

      




        

      • 

        isEnforceSingleParent
        

        public boolean isEnforceSingleParent()
        

        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.
 
        

 
        
 Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.
 
        

        • 

      




        

      • 

        getIncludeLabels
        

        public String getIncludeLabels()
        

        A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
        

        • 

      




        

      • 

        setIncludeLabels
        

        public Drive.Files.Patch setIncludeLabels(String includeLabels)
        

        A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
        

        • 

      




        

      • 

        getIncludePermissionsForView
        

        public String getIncludePermissionsForView()
        

        Specifies which additional view's permissions to include in the response. Only `published` is
     supported.
        

        • 

      




        

      • 

        setIncludePermissionsForView
        

        public Drive.Files.Patch setIncludePermissionsForView(String includePermissionsForView)
        

        Specifies which additional view's permissions to include in the response. Only `published`
 is supported.
        

        • 

      




        

      • 

        getModifiedDateBehavior
        

        public String getModifiedDateBehavior()
        

        Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.
        

        • 

      




        

      • 

        setModifiedDateBehavior
        

        public Drive.Files.Patch setModifiedDateBehavior(String modifiedDateBehavior)
        

        Determines the behavior in which `modifiedDate` is updated. This overrides
 `setModifiedDate`.
        

        • 

      




        

      • 

        getNewRevision
        

        public Boolean getNewRevision()
        

        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](https://support.google.com/drive/answer/2409045). Note that this field is ignored if there
     is no payload in the request. [default: true]
        

        • 

      




        

      • 

        setNewRevision
        

        public Drive.Files.Patch setNewRevision(Boolean newRevision)
        

        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](https://support.google.com/drive/answer/2409045). Note that this field is ignored
 if there is no payload in the request.
        

        • 

      




        

      • 

        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 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](https://support.google.com/drive/answer/2409045). Note that this field is ignored if there
     is no payload in the request.
 
        

        • 

      




        

      • 

        getOcr
        

        public Boolean getOcr()
        

        Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. [default: false]
        

        • 

      












        

      • 

        getOcrLanguage
        

        public String getOcrLanguage()
        

        If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
        

        • 

      




        

      • 

        setOcrLanguage
        

        public Drive.Files.Patch setOcrLanguage(String ocrLanguage)
        

        If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
        

        • 

      




        

      • 

        getPinned
        

        public Boolean getPinned()
        

        Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this
     field is ignored if there is no payload in the request. [default: false]
        

        • 

      




        

      • 

        setPinned
        

        public Drive.Files.Patch setPinned(Boolean pinned)
        

        Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note
 that this field is ignored if there is no payload in the request.
        

        • 

      




        

      • 

        isPinned
        

        public boolean isPinned()
        

        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 pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this
     field is ignored if there is no payload in the request.
 
        

        • 

      




        

      • 

        getRemoveParents
        

        public String getRemoveParents()
        

        Comma-separated list of parent IDs to remove.
        

        • 

      




        

      • 

        setRemoveParents
        

        public Drive.Files.Patch setRemoveParents(String removeParents)
        

        Comma-separated list of parent IDs to remove.
        

        • 

      




        

      • 

        getSetModifiedDate
        

        public Boolean getSetModifiedDate()
        

        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`. [default: false]
        

        • 

      




        

      • 

        setSetModifiedDate
        

        public Drive.Files.Patch setSetModifiedDate(Boolean setModifiedDate)
        

        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`.
        

        • 

      




        

      • 

        isSetModifiedDate
        

        public boolean isSetModifiedDate()
        

        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 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`.
 
        

        • 

      




        

      • 

        getSupportsAllDrives
        

        public Boolean getSupportsAllDrives()
        

        Whether the requesting application supports both My Drives and shared drives. [default: false]
        

        • 

      




        

      • 

        setSupportsAllDrives
        

        public Drive.Files.Patch setSupportsAllDrives(Boolean supportsAllDrives)
        

        Whether the requesting application supports both My Drives and shared drives.
        

        • 

      




        

      • 

        isSupportsAllDrives
        

        public boolean isSupportsAllDrives()
        

        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 both My Drives and shared drives.
 
        

        • 

      




        

      • 

        getSupportsTeamDrives
        

        public Boolean getSupportsTeamDrives()
        

        Deprecated: Use `supportsAllDrives` instead. [default: false]
        

        • 

      




        

      • 

        setSupportsTeamDrives
        

        public Drive.Files.Patch setSupportsTeamDrives(Boolean supportsTeamDrives)
        

        Deprecated: Use `supportsAllDrives` instead.
        

        • 

      




        

      • 

        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.
 
        

 
        
 Deprecated: Use `supportsAllDrives` instead.
 
        

        • 

      




        

      • 

        getTimedTextLanguage
        

        public String getTimedTextLanguage()
        

        The language of the timed text.
        

        • 

      




        

      • 

        setTimedTextLanguage
        

        public Drive.Files.Patch setTimedTextLanguage(String timedTextLanguage)
        

        The language of the timed text.
        

        • 

      




        

      • 

        getTimedTextTrackName
        

        public String getTimedTextTrackName()
        

        The timed text track name.
        

        • 

      




        

      • 

        setTimedTextTrackName
        

        public Drive.Files.Patch setTimedTextTrackName(String timedTextTrackName)
        

        The timed text track name.
        

        • 

      




        

      • 

        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.
 
        

        • 

      




        

      • 

        getUseContentAsIndexableText
        

        public Boolean getUseContentAsIndexableText()
        

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

        • 

      




        

      • 

        setUseContentAsIndexableText
        

        public Drive.Files.Patch setUseContentAsIndexableText(Boolean useContentAsIndexableText)
        

        Whether to use the 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 content as indexable text.
 
        

        • 

      





      • 

    

    • 













Skip navigation links





























Copyright © 2011–2024 Google. All rights reserved.




© 2015 - 2024 Weber Informatics LLC | Privacy Policy