class GoogleDrive::File

• GoogleDrive::File
• Reference
• Object

Overview

The metadata for a file.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constructors

• .new(pull : JSON::PullParser)
• .new(*, app_properties : Hash(String, String) | Nil = nil, capabilities : GoogleDrive::FileCapabilities | Nil = nil, content_hints : GoogleDrive::FileContentHints | Nil = nil, content_restrictions : Array(GoogleDrive::ContentRestriction) | Nil = nil, copy_requires_writer_permission : Bool | Nil = nil, created_time : Time | Nil = nil, description : String | Nil = nil, drive_id : String | Nil = nil, explicitly_trashed : Bool | Nil = nil, export_links : Hash(String, String) | Nil = nil, file_extension : String | Nil = nil, folder_color_rgb : String | Nil = nil, full_file_extension : String | Nil = nil, has_augmented_permissions : Bool | Nil = nil, has_thumbnail : Bool | Nil = nil, head_revision_id : String | Nil = nil, icon_link : String | Nil = nil, id : String | Nil = nil, image_media_metadata : GoogleDrive::FileImageMediaMetadata | Nil = nil, is_app_authorized : Bool | Nil = nil, kind : String | Nil = "drive#file", label_info : GoogleDrive::FileLabelInfo | Nil = nil, last_modifying_user : GoogleDrive::User | Nil = nil, link_share_metadata : GoogleDrive::FileLinkShareMetadata | Nil = nil, md5_checksum : String | Nil = nil, mime_type : String | Nil = nil, modified_by_me : Bool | Nil = nil, modified_by_me_time : Time | Nil = nil, modified_time : Time | Nil = nil, name : String | Nil = nil, original_filename : String | Nil = nil, owned_by_me : Bool | Nil = nil, owners : Array(GoogleDrive::User) | Nil = nil, parents : Array(String) | Nil = nil, permission_ids : Array(String) | Nil = nil, permissions : Array(GoogleDrive::Permission) | Nil = nil, properties : Hash(String, String) | Nil = nil, quota_bytes_used : String | Nil = nil, resource_key : String | Nil = nil, sha1_checksum : String | Nil = nil, sha256_checksum : String | Nil = nil, shared : Bool | Nil = nil, shared_with_me_time : Time | Nil = nil, sharing_user : GoogleDrive::User | Nil = nil, shortcut_details : GoogleDrive::FileShortcutDetails | Nil = nil, size : String | Nil = nil, spaces : Array(String) | Nil = nil, starred : Bool | Nil = nil, team_drive_id : String | Nil = nil, thumbnail_link : String | Nil = nil, thumbnail_version : String | Nil = nil, trashed : Bool | Nil = nil, trashed_time : Time | Nil = nil, trashing_user : GoogleDrive::User | Nil = nil, version : String | Nil = nil, video_media_metadata : GoogleDrive::FileVideoMediaMetadata | Nil = nil, viewed_by_me : Bool | Nil = nil, viewed_by_me_time : Time | Nil = nil, viewers_can_copy_content : Bool | Nil = nil, web_content_link : String | Nil = nil, web_view_link : String | Nil = nil, writers_can_share : Bool | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #app_properties : Hash(String, String) | Nil

  A collection of arbitrary key-value pairs which are private to the requesting app.

• #app_properties=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #capabilities : GoogleDrive::FileCapabilities | Nil
• #capabilities=(new_value : GoogleDrive::FileCapabilities | Nil)

  Custom attribute writer method checking allowed values (enum).

• #content_hints : GoogleDrive::FileContentHints | Nil
• #content_hints=(new_value : GoogleDrive::FileContentHints | Nil)

  Custom attribute writer method checking allowed values (enum).

• #content_restrictions : Array(GoogleDrive::ContentRestriction) | Nil

  Restrictions for accessing the content of the file.

• #content_restrictions=(new_value : Array(GoogleDrive::ContentRestriction) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #copy_requires_writer_permission : Bool | Nil

  Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

• #copy_requires_writer_permission=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created_time : Time | Nil

  The time at which the file was created (RFC 3339 date-time).

• #created_time=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil

  A short description of the file.

• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #drive_id : String | Nil

  ID of the shared drive the file resides in.

• #drive_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #explicitly_trashed : Bool | Nil

  Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

• #explicitly_trashed=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #export_links : Hash(String, String) | Nil

  Links for exporting Docs Editors files to specific formats.

• #export_links=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #file_extension : String | Nil

  The final component of fullFileExtension.

• #file_extension=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #folder_color_rgb : String | Nil

  The color for a folder or shortcut to a folder as an RGB hex string.

• #folder_color_rgb=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #full_file_extension : String | Nil

  The full file extension extracted from the name field.

• #full_file_extension=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #has_augmented_permissions : Bool | Nil

  Whether there are permissions directly on this file.

• #has_augmented_permissions=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #has_thumbnail : Bool | Nil

  Whether this file has a thumbnail.

• #has_thumbnail=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #head_revision_id : String | Nil

  The ID of the file's head revision.

• #head_revision_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #icon_link : String | Nil

  A static, unauthenticated link to the file's icon.

• #icon_link=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #id : String | Nil

  The ID of the file.

• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #image_media_metadata : GoogleDrive::FileImageMediaMetadata | Nil
• #image_media_metadata=(new_value : GoogleDrive::FileImageMediaMetadata | Nil)

  Custom attribute writer method checking allowed values (enum).

• #is_app_authorized : Bool | Nil

  Whether the file was created or opened by the requesting app.

• #is_app_authorized=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #kind : String | Nil

  Identifies what kind of resource this is.

• #kind=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #label_info : GoogleDrive::FileLabelInfo | Nil
• #label_info=(new_value : GoogleDrive::FileLabelInfo | Nil)

  Custom attribute writer method checking allowed values (enum).

• #last_modifying_user : GoogleDrive::User | Nil
• #last_modifying_user=(new_value : GoogleDrive::User | Nil)

  Custom attribute writer method checking allowed values (enum).

• #link_share_metadata : GoogleDrive::FileLinkShareMetadata | Nil
• #link_share_metadata=(new_value : GoogleDrive::FileLinkShareMetadata | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #md5_checksum : String | Nil

  The MD5 checksum for the content of the file.

• #md5_checksum=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #mime_type : String | Nil

  The MIME type of the file.

• #mime_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #modified_by_me : Bool | Nil

  Whether the file has been modified by this user.

• #modified_by_me=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #modified_by_me_time : Time | Nil

  The last time the file was modified by the user (RFC 3339 date-time).

• #modified_by_me_time=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #modified_time : Time | Nil

  The last time the file was modified by anyone (RFC 3339 date-time).

• #modified_time=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #name : String | Nil

  The name of the file.

• #name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #original_filename : String | Nil

  The original filename of the uploaded content if available, or else the original value of the name field.

• #original_filename=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #owned_by_me : Bool | Nil

  Whether the user owns the file.

• #owned_by_me=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #owners : Array(GoogleDrive::User) | Nil

  The owner of this file.

• #owners=(new_value : Array(GoogleDrive::User) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #parents : Array(String) | Nil

  The IDs of the parent folders which contain the file.

• #parents=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #permission_ids : Array(String) | Nil

  List of permission IDs for users with access to this file.

• #permission_ids=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #permissions : Array(GoogleDrive::Permission) | Nil

  The full list of permissions for the file.

• #permissions=(new_value : Array(GoogleDrive::Permission) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #properties : Hash(String, String) | Nil

  A collection of arbitrary key-value pairs which are visible to all apps.

• #properties=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #quota_bytes_used : String | Nil

  The number of storage quota bytes used by the file.

• #quota_bytes_used=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #resource_key : String | Nil

  A key needed to access the item via a shared link.

• #resource_key=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #sha1_checksum : String | Nil

  The SHA1 checksum associated with this file, if available.

• #sha1_checksum=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #sha256_checksum : String | Nil

  The SHA256 checksum associated with this file, if available.

• #sha256_checksum=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shared : Bool | Nil

  Whether the file has been shared.

• #shared=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shared_with_me_time : Time | Nil

  The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

• #shared_with_me_time=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #sharing_user : GoogleDrive::User | Nil
• #sharing_user=(new_value : GoogleDrive::User | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shortcut_details : GoogleDrive::FileShortcutDetails | Nil
• #shortcut_details=(new_value : GoogleDrive::FileShortcutDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

• #size : String | Nil

  The size of the file's content in bytes.

• #size=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #spaces : Array(String) | Nil

  The list of spaces which contain the file.

• #spaces=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #starred : Bool | Nil

  Whether the user has starred the file.

• #starred=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #team_drive_id : String | Nil

  Deprecated - use driveId instead.

• #team_drive_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #thumbnail_link : String | Nil

  A short-lived link to the file's thumbnail, if available.

• #thumbnail_link=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #thumbnail_version : String | Nil

  The thumbnail version for use in thumbnail cache invalidation.

• #thumbnail_version=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #trashed : Bool | Nil

  Whether the file has been trashed, either explicitly or from a trashed parent folder.

• #trashed=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #trashed_time : Time | Nil

  The time that the item was trashed (RFC 3339 date-time).

• #trashed_time=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #trashing_user : GoogleDrive::User | Nil
• #trashing_user=(new_value : GoogleDrive::User | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

• #version : String | Nil

  A monotonically increasing version number for the file.

• #version=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #video_media_metadata : GoogleDrive::FileVideoMediaMetadata | Nil
• #video_media_metadata=(new_value : GoogleDrive::FileVideoMediaMetadata | Nil)

  Custom attribute writer method checking allowed values (enum).

• #viewed_by_me : Bool | Nil

  Whether the file has been viewed by this user.

• #viewed_by_me=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #viewed_by_me_time : Time | Nil

  The last time the file was viewed by the user (RFC 3339 date-time).

• #viewed_by_me_time=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #viewers_can_copy_content : Bool | Nil

  Deprecated - use copyRequiresWriterPermission instead.

• #viewers_can_copy_content=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #web_content_link : String | Nil

  A link for downloading the content of the file in a browser.

• #web_content_link=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #web_view_link : String | Nil

  A link for opening the file in a relevant Google editor or viewer in a browser.

• #web_view_link=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #writers_can_share : Bool | Nil

  Whether users with only writer permission can modify the file's permissions.

• #writers_can_share=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

Constructor Detail

Instance Method Detail