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-rev20240903-2.0.0
Show newest version






Drive.Files.Patch (Drive API v2-rev20180830-1.26.0)













Skip navigation links
































com.google.api.services.drive


Class Drive.Files.Patch



















    

  • 


      

    • 



      Constructor Detail
      




        

      • 

        Patch
        

        protected Patch(String fileId,
                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(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>
        

        

        • 

      




















        

      • 

        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()
        

        This parameter is deprecated and has no function. [default: false]
        

        • 

      












        

      • 

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

        • 

      




        

      • 

        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.
 
        

        • 

      




        

      • 

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

        • 

      




        

      • 

        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.
 
        

        • 

      




        

      • 

        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.
 
        

        • 

      




        

      • 

        getSupportsTeamDrives
        

        public Boolean getSupportsTeamDrives()
        

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

        • 

      




        

      • 

        setSupportsTeamDrives
        

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

        • 

      




        

      • 

        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–2018 Google. All rights reserved.




© 2015 - 2024 Weber Informatics LLC | Privacy Policy