Class: Google::Apis::DriveV2::File
- Inherits:
-
Object
- Object
- Google::Apis::DriveV2::File
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/drive_v2/classes.rb,
lib/google/apis/drive_v2/representations.rb,
lib/google/apis/drive_v2/representations.rb
Overview
The metadata for a file.
Defined Under Namespace
Classes: Capabilities, ImageMediaMetadata, IndexableText, LabelInfo, Labels, LinkShareMetadata, ShortcutDetails, Thumbnail, VideoMediaMetadata
Instance Attribute Summary collapse
-
#alternate_link ⇒ String
A link for opening the file in a relevant Google editor or viewer.
-
#app_data_contents ⇒ Boolean
(also: #app_data_contents?)
Whether this file is in the Application Data folder.
-
#can_comment ⇒ Boolean
(also: #can_comment?)
Deprecated: use capabilities/canComment.
-
#can_read_revisions ⇒ Boolean
(also: #can_read_revisions?)
Deprecated: use capabilities/canReadRevisions.
-
#capabilities ⇒ Google::Apis::DriveV2::File::Capabilities
Capabilities the current user has on this file.
-
#content_restrictions ⇒ Array<Google::Apis::DriveV2::ContentRestriction>
Restrictions for accessing the content of the file.
-
#copy_requires_writer_permission ⇒ Boolean
(also: #copy_requires_writer_permission?)
Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
-
#copyable ⇒ Boolean
(also: #copyable?)
Deprecated: use capabilities/canCopy.
-
#created_date ⇒ DateTime
Create time for this file (formatted RFC 3339 timestamp).
-
#default_open_with_link ⇒ String
A link to open this file with the user's default app for this file.
-
#description ⇒ String
A short description of the file.
-
#download_url ⇒ String
Short lived download URL for the file.
-
#drive_id ⇒ String
ID of the shared drive the file resides in.
-
#editable ⇒ Boolean
(also: #editable?)
Deprecated: use capabilities/canEdit.
-
#embed_link ⇒ String
A link for embedding the file.
-
#etag ⇒ String
ETag of the file.
-
#explicitly_trashed ⇒ Boolean
(also: #explicitly_trashed?)
Whether this file has been explicitly trashed, as opposed to recursively trashed.
-
#export_links ⇒ Hash<String,String>
Links for exporting Docs Editors files to specific formats.
-
#file_extension ⇒ String
The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed.
-
#file_size ⇒ Fixnum
The size of the file's content in bytes.
-
#folder_color_rgb ⇒ String
Folder color as an RGB hex string if the file is a folder or a shortcut to a folder.
-
#full_file_extension ⇒ String
The full file extension; extracted from the title.
-
#has_augmented_permissions ⇒ Boolean
(also: #has_augmented_permissions?)
Whether there are permissions directly on this file.
-
#has_thumbnail ⇒ Boolean
(also: #has_thumbnail?)
Whether this file has a thumbnail.
-
#head_revision_id ⇒ String
The ID of the file's head revision.
-
#icon_link ⇒ String
A link to the file's icon.
-
#id ⇒ String
The ID of the file.
-
#image_media_metadata ⇒ Google::Apis::DriveV2::File::ImageMediaMetadata
Metadata about image media.
-
#indexable_text ⇒ Google::Apis::DriveV2::File::IndexableText
Indexable text attributes for the file (can only be written).
-
#is_app_authorized ⇒ Boolean
(also: #is_app_authorized?)
Whether the file was created or opened by the requesting app.
-
#kind ⇒ String
The type of file.
-
#label_info ⇒ Google::Apis::DriveV2::File::LabelInfo
An overview of the labels on the file.
-
#labels ⇒ Google::Apis::DriveV2::File::Labels
A group of labels for the file.
-
#last_modifying_user ⇒ Google::Apis::DriveV2::User
Information about a Drive user.
-
#last_modifying_user_name ⇒ String
Name of the last user to modify this file.
-
#last_viewed_by_me_date ⇒ DateTime
Last time this file was viewed by the user (formatted RFC 3339 timestamp).
-
#link_share_metadata ⇒ Google::Apis::DriveV2::File::LinkShareMetadata
Contains details about the link URLs that clients are using to refer to this item.
-
#marked_viewed_by_me_date ⇒ DateTime
Deprecated.
-
#md5_checksum ⇒ String
An MD5 checksum for the content of this file.
-
#mime_type ⇒ String
The MIME type of the file.
-
#modified_by_me_date ⇒ DateTime
Last time this file was modified by the user (formatted RFC 3339 timestamp).
-
#modified_date ⇒ DateTime
Last time this file was modified by anyone (formatted RFC 3339 timestamp).
-
#open_with_links ⇒ Hash<String,String>
A map of the id of each of the user's apps to a link to open this file with that app.
-
#original_filename ⇒ String
The original filename of the uploaded content if available, or else the original value of the title field.
-
#owned_by_me ⇒ Boolean
(also: #owned_by_me?)
Whether the file is owned by the current user.
-
#owner_names ⇒ Array<String>
Name(s) of the owner(s) of this file.
-
#owners ⇒ Array<Google::Apis::DriveV2::User>
The owner of this file.
-
#parents ⇒ Array<Google::Apis::DriveV2::ParentReference>
Collection of parent folders which contain this file.
-
#permission_ids ⇒ Array<String>
List of permission IDs for users with access to this file.
-
#permissions ⇒ Array<Google::Apis::DriveV2::Permission>
The list of permissions for users with access to this file.
-
#properties ⇒ Array<Google::Apis::DriveV2::Property>
The list of properties.
-
#quota_bytes_used ⇒ Fixnum
The number of quota bytes used by this file.
-
#resource_key ⇒ String
A key needed to access the item via a shared link.
-
#self_link ⇒ String
A link back to this file.
-
#sha1_checksum ⇒ String
The SHA1 checksum associated with this file, if available.
-
#sha256_checksum ⇒ String
The SHA256 checksum associated with this file, if available.
-
#shareable ⇒ Boolean
(also: #shareable?)
Deprecated: use capabilities/canShare.
-
#shared ⇒ Boolean
(also: #shared?)
Whether the file has been shared.
-
#shared_with_me_date ⇒ DateTime
Time at which this file was shared with the user (formatted RFC 3339 timestamp) .
-
#sharing_user ⇒ Google::Apis::DriveV2::User
Information about a Drive user.
-
#shortcut_details ⇒ Google::Apis::DriveV2::File::ShortcutDetails
Shortcut file details.
-
#spaces ⇒ Array<String>
The list of spaces which contain the file.
-
#team_drive_id ⇒ String
Deprecated - use driveId instead.
-
#thumbnail ⇒ Google::Apis::DriveV2::File::Thumbnail
A thumbnail for the file.
-
#thumbnail_link ⇒ String
A short-lived link to the file's thumbnail.
-
#thumbnail_version ⇒ Fixnum
The thumbnail version for use in thumbnail cache invalidation.
-
#title ⇒ String
The title of this file.
-
#trashed_date ⇒ DateTime
The time that the item was trashed (formatted RFC 3339 timestamp).
-
#trashing_user ⇒ Google::Apis::DriveV2::User
Information about a Drive user.
-
#user_permission ⇒ Google::Apis::DriveV2::Permission
A permission for a file.
-
#version ⇒ Fixnum
A monotonically increasing version number for the file.
-
#video_media_metadata ⇒ Google::Apis::DriveV2::File::VideoMediaMetadata
Metadata about video media.
-
#web_content_link ⇒ String
A link for downloading the content of the file in a browser using cookie based authentication.
-
#web_view_link ⇒ String
A link only available on public folders for viewing their static web assets ( HTML, CSS, JS, etc) via Google Drive's Website Hosting.
-
#writers_can_share ⇒ Boolean
(also: #writers_can_share?)
Whether writers can share the document with other users.
Instance Method Summary collapse
-
#initialize(**args) ⇒ File
constructor
A new instance of File.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ File
Returns a new instance of File.
2253 2254 2255 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2253 def initialize(**args) update!(**args) end |
Instance Attribute Details
#alternate_link ⇒ String
A link for opening the file in a relevant Google editor or viewer.
Corresponds to the JSON property alternateLink
1801 1802 1803 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1801 def alternate_link @alternate_link end |
#app_data_contents ⇒ Boolean Also known as: app_data_contents?
Whether this file is in the Application Data folder.
Corresponds to the JSON property appDataContents
1806 1807 1808 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1806 def app_data_contents @app_data_contents end |
#can_comment ⇒ Boolean Also known as: can_comment?
Deprecated: use capabilities/canComment.
Corresponds to the JSON property canComment
1812 1813 1814 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1812 def can_comment @can_comment end |
#can_read_revisions ⇒ Boolean Also known as: can_read_revisions?
Deprecated: use capabilities/canReadRevisions.
Corresponds to the JSON property canReadRevisions
1818 1819 1820 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1818 def can_read_revisions @can_read_revisions end |
#capabilities ⇒ Google::Apis::DriveV2::File::Capabilities
Capabilities the current user has on this file. Each capability corresponds to
a fine-grained action that a user may take.
Corresponds to the JSON property capabilities
1825 1826 1827 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1825 def capabilities @capabilities end |
#content_restrictions ⇒ Array<Google::Apis::DriveV2::ContentRestriction>
Restrictions for accessing the content of the file. Only populated if such a
restriction exists.
Corresponds to the JSON property contentRestrictions
1831 1832 1833 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1831 def content_restrictions @content_restrictions end |
#copy_requires_writer_permission ⇒ Boolean Also known as: copy_requires_writer_permission?
Whether the options to copy, print, or download this file, should be disabled
for readers and commenters.
Corresponds to the JSON property copyRequiresWriterPermission
1837 1838 1839 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1837 def @copy_requires_writer_permission end |
#copyable ⇒ Boolean Also known as: copyable?
Deprecated: use capabilities/canCopy.
Corresponds to the JSON property copyable
1843 1844 1845 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1843 def copyable @copyable end |
#created_date ⇒ DateTime
Create time for this file (formatted RFC 3339 timestamp).
Corresponds to the JSON property createdDate
1849 1850 1851 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1849 def created_date @created_date end |
#default_open_with_link ⇒ String
A link to open this file with the user's default app for this file. Only
populated when the drive.apps.readonly scope is used.
Corresponds to the JSON property defaultOpenWithLink
1855 1856 1857 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1855 def default_open_with_link @default_open_with_link end |
#description ⇒ String
A short description of the file.
Corresponds to the JSON property description
1860 1861 1862 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1860 def description @description end |
#download_url ⇒ String
Short lived download URL for the file. This field is only populated for files
with content stored in Google Drive; it isn't populated for Docs Editors or
shortcut files.
Corresponds to the JSON property downloadUrl
1867 1868 1869 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1867 def download_url @download_url end |
#drive_id ⇒ String
ID of the shared drive the file resides in. Only populated for items in shared
drives.
Corresponds to the JSON property driveId
1873 1874 1875 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1873 def drive_id @drive_id end |
#editable ⇒ Boolean Also known as: editable?
Deprecated: use capabilities/canEdit.
Corresponds to the JSON property editable
1878 1879 1880 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1878 def editable @editable end |
#embed_link ⇒ String
A link for embedding the file.
Corresponds to the JSON property embedLink
1884 1885 1886 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1884 def @embed_link end |
#etag ⇒ String
ETag of the file.
Corresponds to the JSON property etag
1889 1890 1891 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1889 def etag @etag end |
#explicitly_trashed ⇒ Boolean Also known as: explicitly_trashed?
Whether this file has been explicitly trashed, as opposed to recursively
trashed.
Corresponds to the JSON property explicitlyTrashed
1895 1896 1897 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1895 def explicitly_trashed @explicitly_trashed end |
#export_links ⇒ Hash<String,String>
Links for exporting Docs Editors files to specific formats.
Corresponds to the JSON property exportLinks
1901 1902 1903 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1901 def export_links @export_links end |
#file_extension ⇒ String
The final component of fullFileExtension with trailing text that does not
appear to be part of the extension removed. This field is only populated for
files with content stored in Google Drive; it isn't populated for Docs Editors
or shortcut files.
Corresponds to the JSON property fileExtension
1909 1910 1911 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1909 def file_extension @file_extension end |
#file_size ⇒ Fixnum
The size of the file's content in bytes. This field is populated for files
with binary content stored in Google Drive and for Docs Editors files; it is
not populated for shortcuts or folders.
Corresponds to the JSON property fileSize
1916 1917 1918 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1916 def file_size @file_size end |
#folder_color_rgb ⇒ String
Folder color as an RGB hex string if the file is a folder or a shortcut to a
folder. The list of supported colors is available in the folderColorPalette
field of the About resource. If an unsupported color is specified, it will be
changed to the closest color in the palette.
Corresponds to the JSON property folderColorRgb
1924 1925 1926 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1924 def folder_color_rgb @folder_color_rgb end |
#full_file_extension ⇒ String
The full file extension; extracted from the title. May contain multiple
concatenated extensions, such as "tar.gz". Removing an extension from the
title does not clear this field; however, changing the extension on the title
does update this field. This field is only populated for files with content
stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
Corresponds to the JSON property fullFileExtension
1933 1934 1935 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1933 def full_file_extension @full_file_extension end |
#has_augmented_permissions ⇒ Boolean Also known as: has_augmented_permissions?
Whether there are permissions directly on this file. This field is only
populated for items in shared drives.
Corresponds to the JSON property hasAugmentedPermissions
1939 1940 1941 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1939 def @has_augmented_permissions end |
#has_thumbnail ⇒ Boolean Also known as: has_thumbnail?
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.
Corresponds to the JSON property hasThumbnail
1947 1948 1949 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1947 def has_thumbnail @has_thumbnail end |
#head_revision_id ⇒ String
The ID of the file's head revision. This field is only populated for files
with content stored in Google Drive; it isn't populated for Docs Editors or
shortcut files.
Corresponds to the JSON property headRevisionId
1955 1956 1957 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1955 def head_revision_id @head_revision_id end |
#icon_link ⇒ String
A link to the file's icon.
Corresponds to the JSON property iconLink
1960 1961 1962 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1960 def icon_link @icon_link end |
#id ⇒ String
The ID of the file.
Corresponds to the JSON property id
1965 1966 1967 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1965 def id @id end |
#image_media_metadata ⇒ Google::Apis::DriveV2::File::ImageMediaMetadata
Metadata about image media. This will only be present for image types, and its
contents will depend on what can be parsed from the image content.
Corresponds to the JSON property imageMediaMetadata
1971 1972 1973 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1971 def @image_media_metadata end |
#indexable_text ⇒ Google::Apis::DriveV2::File::IndexableText
Indexable text attributes for the file (can only be written). For more
information, see Manage file metadata.
Corresponds to the JSON property indexableText
1977 1978 1979 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1977 def indexable_text @indexable_text end |
#is_app_authorized ⇒ Boolean Also known as:
Whether the file was created or opened by the requesting app.
Corresponds to the JSON property isAppAuthorized
1982 1983 1984 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1982 def @is_app_authorized end |
#kind ⇒ String
The type of file. This is always drive#file.
Corresponds to the JSON property kind
1988 1989 1990 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1988 def kind @kind end |
#label_info ⇒ Google::Apis::DriveV2::File::LabelInfo
An overview of the labels on the file.
Corresponds to the JSON property labelInfo
1993 1994 1995 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1993 def label_info @label_info end |
#labels ⇒ Google::Apis::DriveV2::File::Labels
A group of labels for the file.
Corresponds to the JSON property labels
1998 1999 2000 |
# File 'lib/google/apis/drive_v2/classes.rb', line 1998 def labels @labels end |
#last_modifying_user ⇒ Google::Apis::DriveV2::User
Information about a Drive user.
Corresponds to the JSON property lastModifyingUser
2003 2004 2005 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2003 def @last_modifying_user end |
#last_modifying_user_name ⇒ String
Name of the last user to modify this file.
Corresponds to the JSON property lastModifyingUserName
2008 2009 2010 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2008 def @last_modifying_user_name end |
#last_viewed_by_me_date ⇒ DateTime
Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Corresponds to the JSON property lastViewedByMeDate
2013 2014 2015 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2013 def last_viewed_by_me_date @last_viewed_by_me_date end |
#link_share_metadata ⇒ Google::Apis::DriveV2::File::LinkShareMetadata
Contains details about the link URLs that clients are using to refer to this
item.
Corresponds to the JSON property linkShareMetadata
2019 2020 2021 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2019 def @link_share_metadata end |
#marked_viewed_by_me_date ⇒ DateTime
Deprecated.
Corresponds to the JSON property markedViewedByMeDate
2024 2025 2026 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2024 def marked_viewed_by_me_date @marked_viewed_by_me_date end |
#md5_checksum ⇒ String
An MD5 checksum for the content of this file. This field is only populated for
files with content stored in Google Drive; it isn't populated for Docs Editors
or shortcut files.
Corresponds to the JSON property md5Checksum
2031 2032 2033 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2031 def md5_checksum @md5_checksum end |
#mime_type ⇒ String
The MIME type of the file. This is only mutable on update when uploading new
content. This field can be left blank, and the mimetype will be determined
from the uploaded content's MIME type.
Corresponds to the JSON property mimeType
2038 2039 2040 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2038 def mime_type @mime_type end |
#modified_by_me_date ⇒ DateTime
Last time this file was modified by the user (formatted RFC 3339 timestamp).
Note that setting modifiedDate will also update the modifiedByMe date for the
user which set the date.
Corresponds to the JSON property modifiedByMeDate
2045 2046 2047 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2045 def modified_by_me_date @modified_by_me_date end |
#modified_date ⇒ DateTime
Last time this file was modified by anyone (formatted RFC 3339 timestamp).
This is only mutable on update when the setModifiedDate parameter is set.
Corresponds to the JSON property modifiedDate
2051 2052 2053 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2051 def modified_date @modified_date end |
#open_with_links ⇒ Hash<String,String>
A map of the id of each of the user's apps to a link to open this file with
that app. Only populated when the drive.apps.readonly scope is used.
Corresponds to the JSON property openWithLinks
2057 2058 2059 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2057 def open_with_links @open_with_links end |
#original_filename ⇒ String
The original filename of the uploaded content if available, or else the
original value of the title field. This is only available for files with
binary content in Google Drive.
Corresponds to the JSON property originalFilename
2064 2065 2066 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2064 def original_filename @original_filename end |
#owned_by_me ⇒ Boolean Also known as: owned_by_me?
Whether the file is owned by the current user. Not populated for items in
shared drives.
Corresponds to the JSON property ownedByMe
2070 2071 2072 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2070 def owned_by_me @owned_by_me end |
#owner_names ⇒ Array<String>
Name(s) of the owner(s) of this file. Not populated for items in shared drives.
Corresponds to the JSON property ownerNames
2076 2077 2078 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2076 def owner_names @owner_names end |
#owners ⇒ Array<Google::Apis::DriveV2::User>
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.
Corresponds to the JSON property owners
2082 2083 2084 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2082 def owners @owners end |
#parents ⇒ Array<Google::Apis::DriveV2::ParentReference>
Collection of parent folders which contain this file.
If not specified as part of an insert 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 can also use the addParents and removeParents parameters to
modify the parents list.
Corresponds to the JSON property parents
2092 2093 2094 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2092 def parents @parents end |
#permission_ids ⇒ Array<String>
List of permission IDs for users with access to this file.
Corresponds to the JSON property permissionIds
2097 2098 2099 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2097 def @permission_ids end |
#permissions ⇒ Array<Google::Apis::DriveV2::Permission>
The list of permissions for users with access to this file. Not populated for
items in shared drives.
Corresponds to the JSON property permissions
2103 2104 2105 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2103 def @permissions end |
#properties ⇒ Array<Google::Apis::DriveV2::Property>
The list of properties.
Corresponds to the JSON property properties
2108 2109 2110 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2108 def properties @properties end |
#quota_bytes_used ⇒ Fixnum
The number of quota bytes used by this file.
Corresponds to the JSON property quotaBytesUsed
2113 2114 2115 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2113 def quota_bytes_used @quota_bytes_used end |
#resource_key ⇒ String
A key needed to access the item via a shared link.
Corresponds to the JSON property resourceKey
2118 2119 2120 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2118 def resource_key @resource_key end |
#self_link ⇒ String
A link back to this file.
Corresponds to the JSON property selfLink
2123 2124 2125 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2123 def self_link @self_link end |
#sha1_checksum ⇒ String
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.
Corresponds to the JSON property sha1Checksum
2130 2131 2132 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2130 def sha1_checksum @sha1_checksum end |
#sha256_checksum ⇒ String
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.
Corresponds to the JSON property sha256Checksum
2137 2138 2139 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2137 def sha256_checksum @sha256_checksum end |
#shareable ⇒ Boolean Also known as:
Deprecated: use capabilities/canShare.
Corresponds to the JSON property shareable
2142 2143 2144 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2142 def shareable @shareable end |
#shared ⇒ Boolean Also known as:
Whether the file has been shared. Not populated for items in shared drives.
Corresponds to the JSON property shared
2148 2149 2150 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2148 def shared @shared end |
#shared_with_me_date ⇒ DateTime
Time at which this file was shared with the user (formatted RFC 3339 timestamp)
.
Corresponds to the JSON property sharedWithMeDate
2155 2156 2157 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2155 def shared_with_me_date @shared_with_me_date end |
#sharing_user ⇒ Google::Apis::DriveV2::User
Information about a Drive user.
Corresponds to the JSON property sharingUser
2160 2161 2162 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2160 def sharing_user @sharing_user end |
#shortcut_details ⇒ Google::Apis::DriveV2::File::ShortcutDetails
Shortcut file details. Only populated for shortcut files, which have the
mimeType field set to application/vnd.google-apps.shortcut.
Corresponds to the JSON property shortcutDetails
2166 2167 2168 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2166 def shortcut_details @shortcut_details end |
#spaces ⇒ Array<String>
The list of spaces which contain the file. Supported values are 'drive', '
appDataFolder' and 'photos'.
Corresponds to the JSON property spaces
2172 2173 2174 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2172 def spaces @spaces end |
#team_drive_id ⇒ String
Deprecated - use driveId instead.
Corresponds to the JSON property teamDriveId
2177 2178 2179 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2177 def team_drive_id @team_drive_id end |
#thumbnail ⇒ Google::Apis::DriveV2::File::Thumbnail
A thumbnail for the file. This will only be used if a standard thumbnail
cannot be generated.
Corresponds to the JSON property thumbnail
2183 2184 2185 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2183 def thumbnail @thumbnail end |
#thumbnail_link ⇒ String
A short-lived link to the file's thumbnail. 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.
Corresponds to the JSON property thumbnailLink
2191 2192 2193 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2191 def thumbnail_link @thumbnail_link end |
#thumbnail_version ⇒ Fixnum
The thumbnail version for use in thumbnail cache invalidation.
Corresponds to the JSON property thumbnailVersion
2196 2197 2198 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2196 def thumbnail_version @thumbnail_version end |
#title ⇒ String
The title of this file. Note that for immutable items such as the top level
folders of shared drives, My Drive root folder, and Application Data folder
the title is constant.
Corresponds to the JSON property title
2203 2204 2205 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2203 def title @title end |
#trashed_date ⇒ DateTime
The time that the item was trashed (formatted RFC 3339 timestamp). Only
populated for items in shared drives.
Corresponds to the JSON property trashedDate
2209 2210 2211 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2209 def trashed_date @trashed_date end |
#trashing_user ⇒ Google::Apis::DriveV2::User
Information about a Drive user.
Corresponds to the JSON property trashingUser
2214 2215 2216 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2214 def trashing_user @trashing_user end |
#user_permission ⇒ Google::Apis::DriveV2::Permission
A permission for a file.
Corresponds to the JSON property userPermission
2219 2220 2221 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2219 def @user_permission end |
#version ⇒ Fixnum
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
requesting user.
Corresponds to the JSON property version
2226 2227 2228 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2226 def version @version end |
#video_media_metadata ⇒ Google::Apis::DriveV2::File::VideoMediaMetadata
Metadata about video media. This will only be present for video types.
Corresponds to the JSON property videoMediaMetadata
2231 2232 2233 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2231 def @video_media_metadata end |
#web_content_link ⇒ String
A link for downloading the content of the file in a browser using cookie based
authentication. In cases where the content is shared publicly, the content can
be downloaded without any credentials.
Corresponds to the JSON property webContentLink
2238 2239 2240 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2238 def web_content_link @web_content_link end |
#web_view_link ⇒ String
A link only available on public folders for viewing their static web assets (
HTML, CSS, JS, etc) via Google Drive's Website Hosting.
Corresponds to the JSON property webViewLink
2244 2245 2246 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2244 def web_view_link @web_view_link end |
#writers_can_share ⇒ Boolean Also known as:
Whether writers can share the document with other users. Not populated for
items in shared drives.
Corresponds to the JSON property writersCanShare
2250 2251 2252 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2250 def writers_can_share @writers_can_share end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 |
# File 'lib/google/apis/drive_v2/classes.rb', line 2258 def update!(**args) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @app_data_contents = args[:app_data_contents] if args.key?(:app_data_contents) @can_comment = args[:can_comment] if args.key?(:can_comment) @can_read_revisions = args[:can_read_revisions] if args.key?(:can_read_revisions) @capabilities = args[:capabilities] if args.key?(:capabilities) @content_restrictions = args[:content_restrictions] if args.key?(:content_restrictions) @copy_requires_writer_permission = args[:copy_requires_writer_permission] if args.key?(:copy_requires_writer_permission) @copyable = args[:copyable] if args.key?(:copyable) @created_date = args[:created_date] if args.key?(:created_date) @default_open_with_link = args[:default_open_with_link] if args.key?(:default_open_with_link) @description = args[:description] if args.key?(:description) @download_url = args[:download_url] if args.key?(:download_url) @drive_id = args[:drive_id] if args.key?(:drive_id) @editable = args[:editable] if args.key?(:editable) @embed_link = args[:embed_link] if args.key?(:embed_link) @etag = args[:etag] if args.key?(:etag) @explicitly_trashed = args[:explicitly_trashed] if args.key?(:explicitly_trashed) @export_links = args[:export_links] if args.key?(:export_links) @file_extension = args[:file_extension] if args.key?(:file_extension) @file_size = args[:file_size] if args.key?(:file_size) @folder_color_rgb = args[:folder_color_rgb] if args.key?(:folder_color_rgb) @full_file_extension = args[:full_file_extension] if args.key?(:full_file_extension) @has_augmented_permissions = args[:has_augmented_permissions] if args.key?(:has_augmented_permissions) @has_thumbnail = args[:has_thumbnail] if args.key?(:has_thumbnail) @head_revision_id = args[:head_revision_id] if args.key?(:head_revision_id) @icon_link = args[:icon_link] if args.key?(:icon_link) @id = args[:id] if args.key?(:id) @image_media_metadata = args[:image_media_metadata] if args.key?(:image_media_metadata) @indexable_text = args[:indexable_text] if args.key?(:indexable_text) @is_app_authorized = args[:is_app_authorized] if args.key?(:is_app_authorized) @kind = args[:kind] if args.key?(:kind) @label_info = args[:label_info] if args.key?(:label_info) @labels = args[:labels] if args.key?(:labels) @last_modifying_user = args[:last_modifying_user] if args.key?(:last_modifying_user) @last_modifying_user_name = args[:last_modifying_user_name] if args.key?(:last_modifying_user_name) @last_viewed_by_me_date = args[:last_viewed_by_me_date] if args.key?(:last_viewed_by_me_date) @link_share_metadata = args[:link_share_metadata] if args.key?(:link_share_metadata) @marked_viewed_by_me_date = args[:marked_viewed_by_me_date] if args.key?(:marked_viewed_by_me_date) @md5_checksum = args[:md5_checksum] if args.key?(:md5_checksum) @mime_type = args[:mime_type] if args.key?(:mime_type) @modified_by_me_date = args[:modified_by_me_date] if args.key?(:modified_by_me_date) @modified_date = args[:modified_date] if args.key?(:modified_date) @open_with_links = args[:open_with_links] if args.key?(:open_with_links) @original_filename = args[:original_filename] if args.key?(:original_filename) @owned_by_me = args[:owned_by_me] if args.key?(:owned_by_me) @owner_names = args[:owner_names] if args.key?(:owner_names) @owners = args[:owners] if args.key?(:owners) @parents = args[:parents] if args.key?(:parents) @permission_ids = args[:permission_ids] if args.key?(:permission_ids) @permissions = args[:permissions] if args.key?(:permissions) @properties = args[:properties] if args.key?(:properties) @quota_bytes_used = args[:quota_bytes_used] if args.key?(:quota_bytes_used) @resource_key = args[:resource_key] if args.key?(:resource_key) @self_link = args[:self_link] if args.key?(:self_link) @sha1_checksum = args[:sha1_checksum] if args.key?(:sha1_checksum) @sha256_checksum = args[:sha256_checksum] if args.key?(:sha256_checksum) @shareable = args[:shareable] if args.key?(:shareable) @shared = args[:shared] if args.key?(:shared) @shared_with_me_date = args[:shared_with_me_date] if args.key?(:shared_with_me_date) @sharing_user = args[:sharing_user] if args.key?(:sharing_user) @shortcut_details = args[:shortcut_details] if args.key?(:shortcut_details) @spaces = args[:spaces] if args.key?(:spaces) @team_drive_id = args[:team_drive_id] if args.key?(:team_drive_id) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @thumbnail_link = args[:thumbnail_link] if args.key?(:thumbnail_link) @thumbnail_version = args[:thumbnail_version] if args.key?(:thumbnail_version) @title = args[:title] if args.key?(:title) @trashed_date = args[:trashed_date] if args.key?(:trashed_date) @trashing_user = args[:trashing_user] if args.key?(:trashing_user) @user_permission = args[:user_permission] if args.key?(:user_permission) @version = args[:version] if args.key?(:version) @video_media_metadata = args[:video_media_metadata] if args.key?(:video_media_metadata) @web_content_link = args[:web_content_link] if args.key?(:web_content_link) @web_view_link = args[:web_view_link] if args.key?(:web_view_link) @writers_can_share = args[:writers_can_share] if args.key?(:writers_can_share) end |