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

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

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






Drive.Files.Create (Google Drive API v3-rev20241027-2.0.0)












com.google.api.services.drive

Class Drive.Files.Create

    • Constructor Detail

      • Create

        protected Create(File content)
        Creates 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.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "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.create". 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
      • Create

        protected Create(File content,
                         com.google.api.client.http.AbstractInputStreamContent mediaContent)
        Creates 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.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "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.create". 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.Create 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.Create 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>
      • getEnforceSingleParent

        public Boolean getEnforceSingleParent()
        Deprecated. Creating files in multiple folders is no longer supported. [default: false]
      • setEnforceSingleParent

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

      • getIgnoreDefaultVisibility

        public Boolean getIgnoreDefaultVisibility()
        Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. [default: false]
      • setIgnoreDefaultVisibility

        public Drive.Files.Create setIgnoreDefaultVisibility(Boolean ignoreDefaultVisibility)
        Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
      • isIgnoreDefaultVisibility

        public boolean isIgnoreDefaultVisibility()
        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 ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

      • 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.Create 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.Create setIncludePermissionsForView(String includePermissionsForView)
        Specifies which additional view's permissions to include in the response. Only 'published' is supported.
      • getKeepRevisionForever

        public Boolean getKeepRevisionForever()
        Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. [default: false]
      • setKeepRevisionForever

        public Drive.Files.Create setKeepRevisionForever(Boolean keepRevisionForever)
        Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
      • isKeepRevisionForever

        public boolean isKeepRevisionForever()
        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 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

      • getOcrLanguage

        public String getOcrLanguage()
        A language hint for OCR processing during image import (ISO 639-1 code).
      • setOcrLanguage

        public Drive.Files.Create setOcrLanguage(String ocrLanguage)
        A language hint for OCR processing during image import (ISO 639-1 code).
      • getSupportsAllDrives

        public Boolean getSupportsAllDrives()
        Whether the requesting application supports both My Drives and shared drives. [default: false]
      • setSupportsAllDrives

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

      • getUseContentAsIndexableText

        public Boolean getUseContentAsIndexableText()
        Whether to use the uploaded content as indexable text. [default: false]
      • setUseContentAsIndexableText

        public Drive.Files.Create setUseContentAsIndexableText(Boolean useContentAsIndexableText)
        Whether to use the uploaded 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 uploaded content as indexable text.

Copyright © 2011–2024 Google. All rights reserved.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy