All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

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

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





Drive.Files.Insert (Google Drive API v2-rev20240521-2.0.0)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.drive
    

    Class Drive.Files.Insert
    

    

    


    


    

    


    

    

      

    • 


        

      • 



        Constructor Detail
        




          

        • 

          Insert
          

          protected Insert(File content)
          

          Inserts a new file. This method supports an upload* URI and accepts uploaded media with the
 following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*`
 Note: Specify a valid MIME type, rather than the literal `*` value. The literal `*` is only
 used to indicate that any valid MIME type can be uploaded. For more information on uploading
 files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with
 `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should
 specify a file extension in the `title` property when inserting files with the API. For
 example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"`
 in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property
 populated with the extension originally specified in the `title` property. When a Google Drive
 user requests to download a file, or when the file is downloaded through the sync client, Drive
 builds a full filename (with extension) based on the title. In cases where the extension is
 missing, Drive attempts to determine the extension based on the file's MIME type.

 Create a request for the method "files.insert".

 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:
          

          content - the File
          

          Since:
          

          1.13
          

          

          • 

        




          

        • 

          Insert
          

          protected Insert(File content,
                 com.google.api.client.http.AbstractInputStreamContent mediaContent)
          

          Inserts a new file. This method supports an upload* URI and accepts uploaded media with the
 following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*`
 Note: Specify a valid MIME type, rather than the literal `*` value. The literal `*` is only
 used to indicate that any valid MIME type can be uploaded. For more information on uploading
 files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with
 `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should
 specify a file extension in the `title` property when inserting files with the API. For
 example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"`
 in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property
 populated with the extension originally specified in the `title` property. When a Google Drive
 user requests to download a file, or when the file is downloaded through the sync client, Drive
 builds a full filename (with extension) based on the title. In cases where the extension is
 missing, Drive attempts to determine the extension based on the file's MIME type.

 Create a request for the method "files.insert".

 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:
          

          content - the File media metadata or null if none
          

          mediaContent - The media HTTP content.
          

          Since:
          

          1.13
          

          

          • 

        

        • 

      


        

      • 



        Method Detail
        
























          

        • 

          setKey
          

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

          

          • 

        












          

        • 

          getConvert
          

          public Boolean getConvert()
          

          Whether to convert this file to the corresponding Docs Editors format. [default: false]
          

          • 

        




          

        • 

          setConvert
          

          public Drive.Files.Insert setConvert(Boolean convert)
          

          Whether to convert this file to the corresponding Docs Editors format.
          

          • 

        




          

        • 

          isConvert
          

          public boolean isConvert()
          

          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 convert this file to the corresponding Docs Editors format.
 
          

          • 

        




          

        • 

          getEnforceSingleParent
          

          public Boolean getEnforceSingleParent()
          

          Deprecated: Creating files in multiple folders is no longer supported. [default: false]
          

          • 

        




          

        • 

          setEnforceSingleParent
          

          public Drive.Files.Insert setEnforceSingleParent(Boolean enforceSingleParent)
          

          Deprecated: Creating files in multiple folders is no longer supported.
          

          • 

        




          

        • 

          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: Creating files in multiple folders is no longer supported.
 
          

          • 

        




          

        • 

          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.Insert 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.Insert setIncludePermissionsForView(String includePermissionsForView)
          

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

          • 

        




          

        • 

          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.Insert 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 head revision of the uploaded file. A file can have a maximum of 200 pinned
     revisions. [default: false]
          

          • 

        




          

        • 

          setPinned
          

          public Drive.Files.Insert setPinned(Boolean pinned)
          

          Whether to pin the head revision of the uploaded file. 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 head revision of the uploaded file. A file can have a maximum of 200 pinned
     revisions.
 
          

          • 

        




          

        • 

          getSupportsAllDrives
          

          public Boolean getSupportsAllDrives()
          

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

          • 

        




          

        • 

          setSupportsAllDrives
          

          public Drive.Files.Insert 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.Insert 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.Insert setTimedTextLanguage(String timedTextLanguage)
          

          The language of the timed text.
          

          • 

        




          

        • 

          getTimedTextTrackName
          

          public String getTimedTextTrackName()
          

          The timed text track name.
          

          • 

        




          

        • 

          setTimedTextTrackName
          

          public Drive.Files.Insert setTimedTextTrackName(String timedTextTrackName)
          

          The timed text track name.
          

          • 

        




          

        • 

          getUseContentAsIndexableText
          

          public Boolean getUseContentAsIndexableText()
          

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

          • 

        




          

        • 

          setUseContentAsIndexableText
          

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

          • 

        




          

        • 

          getVisibility
          

          public String getVisibility()
          

          The visibility of the new file. This parameter is only relevant when convert=false. [default:
     DEFAULT]
          

          • 

        




          

        • 

          setVisibility
          

          public Drive.Files.Insert setVisibility(String visibility)
          

          The visibility of the new file. This parameter is only relevant when convert=false.
          

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2024 Google. All rights reserved.




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy