GoogleDrive::File
Inherits OpenApi::Json / OpenApi::Validatable / JSON::Serializable::Unmapped / JSON::Serializable / Reference / Object
The metadata for a file.
Constructors
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Custom attribute writer method checking allowed values (enum). @param [Object] app_properties Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] capabilities Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] content_hints Object to be assigned
Restrictions for accessing the content of the file. Only populated if such a restriction exists.
Custom attribute writer method checking allowed values (enum). @param [Object] content_restrictions Object to be assigned
Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
Custom attribute writer method checking allowed values (enum). @param [Object] copy_requires_writer_permission Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created_time Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
ID of the shared drive the file resides in. Only populated for items in shared drives.
Custom attribute writer method checking allowed values (enum). @param [Object] drive_id Object to be assigned
Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
Custom attribute writer method checking allowed values (enum). @param [Object] explicitly_trashed Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] export_links Object to be assigned
The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
Custom attribute writer method checking allowed values (enum). @param [Object] file_extension Object to be assigned
The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.
Custom attribute writer method checking allowed values (enum). @param [Object] folder_color_rgb Object to be assigned
The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it isn't cleared if the new name does not contain a valid extension.
Custom attribute writer method checking allowed values (enum). @param [Object] full_file_extension Object to be assigned
Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Custom attribute writer method checking allowed values (enum). @param [Object] has_augmented_permissions Object to be assigned
Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
Custom attribute writer method checking allowed values (enum). @param [Object] has_thumbnail Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
Custom attribute writer method checking allowed values (enum). @param [Object] head_revision_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] icon_link Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] image_media_metadata Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] is_app_authorized Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] kind Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] label_info Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] last_modifying_user Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
Custom attribute writer method checking allowed values (enum). @param [Object] md5_checksum Object to be assigned
The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
Custom attribute writer method checking allowed values (enum). @param [Object] mime_type Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] modified_by_me Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] modified_by_me_time Object to be assigned
The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
Custom attribute writer method checking allowed values (enum). @param [Object] modified_time Object to be assigned
The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned
The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
Custom attribute writer method checking allowed values (enum). @param [Object] original_filename Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] owned_by_me Object to be assigned
The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
Custom attribute writer method checking allowed values (enum). @param [Object] owners Object to be assigned
The IDs of the parent folders which contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
Custom attribute writer method checking allowed values (enum). @param [Object] parents Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] permission_ids Object to be assigned
The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
Custom attribute writer method checking allowed values (enum). @param [Object] permissions Object to be assigned
A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.
Custom attribute writer method checking allowed values (enum). @param [Object] properties Object to be assigned
The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
Custom attribute writer method checking allowed values (enum). @param [Object] quota_bytes_used Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] resource_key Object to be assigned
The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
Custom attribute writer method checking allowed values (enum). @param [Object] sha1_checksum Object to be assigned
The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
Custom attribute writer method checking allowed values (enum). @param [Object] sha256_checksum Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] sharing_user Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] shortcut_details Object to be assigned
The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.
Custom attribute writer method checking allowed values (enum). @param [Object] size Object to be assigned
The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
Custom attribute writer method checking allowed values (enum). @param [Object] spaces Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] starred Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] team_drive_id Object to be assigned
A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
Custom attribute writer method checking allowed values (enum). @param [Object] thumbnail_link Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] thumbnail_version Object to be assigned
Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
Custom attribute writer method checking allowed values (enum). @param [Object] trashed Object to be assigned
The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
Custom attribute writer method checking allowed values (enum). @param [Object] trashed_time Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] trashing_user Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid
A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
Custom attribute writer method checking allowed values (enum). @param [Object] version Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] video_media_metadata Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] viewed_by_me Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] viewed_by_me_time Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] viewers_can_copy_content Object to be assigned
A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
Custom attribute writer method checking allowed values (enum). @param [Object] web_content_link Object to be assigned