Class: Google::Apis::DriveV3::File

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/drive_v3/classes.rb,
generated/google/apis/drive_v3/representations.rb,
generated/google/apis/drive_v3/representations.rb

Overview

The metadata for a file.

Defined Under Namespace

Classes: Capabilities, ContentHints, ImageMediaMetadata, ShortcutDetails, VideoMediaMetadata

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ File

Returns a new instance of File.



1302
1303
1304
# File 'generated/google/apis/drive_v3/classes.rb', line 1302

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_propertiesHash<String,String>

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. Corresponds to the JSON property appProperties

Returns:

  • (Hash<String,String>)


961
962
963
# File 'generated/google/apis/drive_v3/classes.rb', line 961

def app_properties
  @app_properties
end

#capabilitiesGoogle::Apis::DriveV3::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



967
968
969
# File 'generated/google/apis/drive_v3/classes.rb', line 967

def capabilities
  @capabilities
end

#content_hintsGoogle::Apis::DriveV3::File::ContentHints

Additional information about the content of the file. These fields are never populated in responses. Corresponds to the JSON property contentHints



973
974
975
# File 'generated/google/apis/drive_v3/classes.rb', line 973

def content_hints
  @content_hints
end

#copy_requires_writer_permissionBoolean 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

Returns:

  • (Boolean)


979
980
981
# File 'generated/google/apis/drive_v3/classes.rb', line 979

def copy_requires_writer_permission
  @copy_requires_writer_permission
end

#created_timeDateTime

The time at which the file was created (RFC 3339 date-time). Corresponds to the JSON property createdTime

Returns:

  • (DateTime)


985
986
987
# File 'generated/google/apis/drive_v3/classes.rb', line 985

def created_time
  @created_time
end

#descriptionString

A short description of the file. Corresponds to the JSON property description

Returns:

  • (String)


990
991
992
# File 'generated/google/apis/drive_v3/classes.rb', line 990

def description
  @description
end

#drive_idString

ID of the shared drive the file resides in. Only populated for items in shared drives. Corresponds to the JSON property driveId

Returns:

  • (String)


996
997
998
# File 'generated/google/apis/drive_v3/classes.rb', line 996

def drive_id
  @drive_id
end

#explicitly_trashedBoolean Also known as: explicitly_trashed?

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

Returns:

  • (Boolean)


1002
1003
1004
# File 'generated/google/apis/drive_v3/classes.rb', line 1002

def explicitly_trashed
  @explicitly_trashed
end

Links for exporting Google Docs to specific formats. Corresponds to the JSON property exportLinks

Returns:

  • (Hash<String,String>)


1008
1009
1010
# File 'generated/google/apis/drive_v3/classes.rb', line 1008

def export_links
  @export_links
end

#file_extensionString

The final component of fullFileExtension. This is only available for files with binary content in Google Drive. Corresponds to the JSON property fileExtension

Returns:

  • (String)


1014
1015
1016
# File 'generated/google/apis/drive_v3/classes.rb', line 1014

def file_extension
  @file_extension
end

#folder_color_rgbString

The color for 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. Corresponds to the JSON property folderColorRgb

Returns:

  • (String)


1022
1023
1024
# File 'generated/google/apis/drive_v3/classes.rb', line 1022

def folder_color_rgb
  @folder_color_rgb
end

#full_file_extensionString

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 is not cleared if the new name does not contain a valid extension. Corresponds to the JSON property fullFileExtension

Returns:

  • (String)


1031
1032
1033
# File 'generated/google/apis/drive_v3/classes.rb', line 1031

def full_file_extension
  @full_file_extension
end

#has_augmented_permissionsBoolean 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

Returns:

  • (Boolean)


1037
1038
1039
# File 'generated/google/apis/drive_v3/classes.rb', line 1037

def has_augmented_permissions
  @has_augmented_permissions
end

#has_thumbnailBoolean 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

Returns:

  • (Boolean)


1045
1046
1047
# File 'generated/google/apis/drive_v3/classes.rb', line 1045

def has_thumbnail
  @has_thumbnail
end

#head_revision_idString

The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. Corresponds to the JSON property headRevisionId

Returns:

  • (String)


1052
1053
1054
# File 'generated/google/apis/drive_v3/classes.rb', line 1052

def head_revision_id
  @head_revision_id
end

A static, unauthenticated link to the file's icon. Corresponds to the JSON property iconLink

Returns:

  • (String)


1057
1058
1059
# File 'generated/google/apis/drive_v3/classes.rb', line 1057

def icon_link
  @icon_link
end

#idString

The ID of the file. Corresponds to the JSON property id

Returns:

  • (String)


1062
1063
1064
# File 'generated/google/apis/drive_v3/classes.rb', line 1062

def id
  @id
end

#image_media_metadataGoogle::Apis::DriveV3::File::ImageMediaMetadata

Additional metadata about image media, if available. Corresponds to the JSON property imageMediaMetadata



1067
1068
1069
# File 'generated/google/apis/drive_v3/classes.rb', line 1067

def 
  @image_media_metadata
end

#is_app_authorizedBoolean Also known as: is_app_authorized?

Whether the file was created or opened by the requesting app. Corresponds to the JSON property isAppAuthorized

Returns:

  • (Boolean)


1072
1073
1074
# File 'generated/google/apis/drive_v3/classes.rb', line 1072

def is_app_authorized
  @is_app_authorized
end

#kindString

Identifies what kind of resource this is. Value: the fixed string "drive#file". Corresponds to the JSON property kind

Returns:

  • (String)


1078
1079
1080
# File 'generated/google/apis/drive_v3/classes.rb', line 1078

def kind
  @kind
end

#last_modifying_userGoogle::Apis::DriveV3::User

Information about a Drive user. Corresponds to the JSON property lastModifyingUser



1083
1084
1085
# File 'generated/google/apis/drive_v3/classes.rb', line 1083

def last_modifying_user
  @last_modifying_user
end

#md5_checksumString

The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. Corresponds to the JSON property md5Checksum

Returns:

  • (String)


1089
1090
1091
# File 'generated/google/apis/drive_v3/classes.rb', line 1089

def md5_checksum
  @md5_checksum
end

#mime_typeString

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. Corresponds to the JSON property mimeType

Returns:

  • (String)


1100
1101
1102
# File 'generated/google/apis/drive_v3/classes.rb', line 1100

def mime_type
  @mime_type
end

#modified_by_meBoolean Also known as: modified_by_me?

Whether the file has been modified by this user. Corresponds to the JSON property modifiedByMe

Returns:

  • (Boolean)


1105
1106
1107
# File 'generated/google/apis/drive_v3/classes.rb', line 1105

def modified_by_me
  @modified_by_me
end

#modified_by_me_timeDateTime

The last time the file was modified by the user (RFC 3339 date-time). Corresponds to the JSON property modifiedByMeTime

Returns:

  • (DateTime)


1111
1112
1113
# File 'generated/google/apis/drive_v3/classes.rb', line 1111

def modified_by_me_time
  @modified_by_me_time
end

#modified_timeDateTime

The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. Corresponds to the JSON property modifiedTime

Returns:

  • (DateTime)


1117
1118
1119
# File 'generated/google/apis/drive_v3/classes.rb', line 1117

def modified_time
  @modified_time
end

#nameString

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. Corresponds to the JSON property name

Returns:

  • (String)


1124
1125
1126
# File 'generated/google/apis/drive_v3/classes.rb', line 1124

def name
  @name
end

#original_filenameString

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. Corresponds to the JSON property originalFilename

Returns:

  • (String)


1131
1132
1133
# File 'generated/google/apis/drive_v3/classes.rb', line 1131

def original_filename
  @original_filename
end

#owned_by_meBoolean Also known as: owned_by_me?

Whether the user owns the file. Not populated for items in shared drives. Corresponds to the JSON property ownedByMe

Returns:

  • (Boolean)


1136
1137
1138
# File 'generated/google/apis/drive_v3/classes.rb', line 1136

def owned_by_me
  @owned_by_me
end

#ownersArray<Google::Apis::DriveV3::User>

The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives. Corresponds to the JSON property owners

Returns:



1143
1144
1145
# File 'generated/google/apis/drive_v3/classes.rb', line 1143

def owners
  @owners
end

#parentsArray<String>

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. Corresponds to the JSON property parents

Returns:

  • (Array<String>)


1153
1154
1155
# File 'generated/google/apis/drive_v3/classes.rb', line 1153

def parents
  @parents
end

#permission_idsArray<String>

List of permission IDs for users with access to this file. Corresponds to the JSON property permissionIds

Returns:

  • (Array<String>)


1158
1159
1160
# File 'generated/google/apis/drive_v3/classes.rb', line 1158

def permission_ids
  @permission_ids
end

#permissionsArray<Google::Apis::DriveV3::Permission>

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. Corresponds to the JSON property permissions



1164
1165
1166
# File 'generated/google/apis/drive_v3/classes.rb', line 1164

def permissions
  @permissions
end

#propertiesHash<String,String>

A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests. Corresponds to the JSON property properties

Returns:

  • (Hash<String,String>)


1170
1171
1172
# File 'generated/google/apis/drive_v3/classes.rb', line 1170

def properties
  @properties
end

#quota_bytes_usedFixnum

The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled. Corresponds to the JSON property quotaBytesUsed

Returns:

  • (Fixnum)


1176
1177
1178
# File 'generated/google/apis/drive_v3/classes.rb', line 1176

def quota_bytes_used
  @quota_bytes_used
end

#sharedBoolean Also known as: shared?

Whether the file has been shared. Not populated for items in shared drives. Corresponds to the JSON property shared

Returns:

  • (Boolean)


1181
1182
1183
# File 'generated/google/apis/drive_v3/classes.rb', line 1181

def shared
  @shared
end

#shared_with_me_timeDateTime

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

Returns:

  • (DateTime)


1188
1189
1190
# File 'generated/google/apis/drive_v3/classes.rb', line 1188

def shared_with_me_time
  @shared_with_me_time
end

#sharing_userGoogle::Apis::DriveV3::User

Information about a Drive user. Corresponds to the JSON property sharingUser



1193
1194
1195
# File 'generated/google/apis/drive_v3/classes.rb', line 1193

def sharing_user
  @sharing_user
end

#shortcut_detailsGoogle::Apis::DriveV3::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



1199
1200
1201
# File 'generated/google/apis/drive_v3/classes.rb', line 1199

def shortcut_details
  @shortcut_details
end

#sizeFixnum

The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive. Corresponds to the JSON property size

Returns:

  • (Fixnum)


1205
1206
1207
# File 'generated/google/apis/drive_v3/classes.rb', line 1205

def size
  @size
end

#spacesArray<String>

The list of spaces which contain the file. The currently supported values are ' drive', 'appDataFolder' and 'photos'. Corresponds to the JSON property spaces

Returns:

  • (Array<String>)


1211
1212
1213
# File 'generated/google/apis/drive_v3/classes.rb', line 1211

def spaces
  @spaces
end

#starredBoolean Also known as: starred?

Whether the user has starred the file. Corresponds to the JSON property starred

Returns:

  • (Boolean)


1216
1217
1218
# File 'generated/google/apis/drive_v3/classes.rb', line 1216

def starred
  @starred
end

#team_drive_idString

Deprecated - use driveId instead. Corresponds to the JSON property teamDriveId

Returns:

  • (String)


1222
1223
1224
# File 'generated/google/apis/drive_v3/classes.rb', line 1222

def team_drive_id
  @team_drive_id
end

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. Corresponds to the JSON property thumbnailLink

Returns:

  • (String)


1229
1230
1231
# File 'generated/google/apis/drive_v3/classes.rb', line 1229

def thumbnail_link
  @thumbnail_link
end

#thumbnail_versionFixnum

The thumbnail version for use in thumbnail cache invalidation. Corresponds to the JSON property thumbnailVersion

Returns:

  • (Fixnum)


1234
1235
1236
# File 'generated/google/apis/drive_v3/classes.rb', line 1234

def thumbnail_version
  @thumbnail_version
end

#trashedBoolean Also known as: trashed?

Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. Corresponds to the JSON property trashed

Returns:

  • (Boolean)


1241
1242
1243
# File 'generated/google/apis/drive_v3/classes.rb', line 1241

def trashed
  @trashed
end

#trashed_timeDateTime

The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. Corresponds to the JSON property trashedTime

Returns:

  • (DateTime)


1248
1249
1250
# File 'generated/google/apis/drive_v3/classes.rb', line 1248

def trashed_time
  @trashed_time
end

#trashing_userGoogle::Apis::DriveV3::User

Information about a Drive user. Corresponds to the JSON property trashingUser



1253
1254
1255
# File 'generated/google/apis/drive_v3/classes.rb', line 1253

def trashing_user
  @trashing_user
end

#versionFixnum

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. Corresponds to the JSON property version

Returns:

  • (Fixnum)


1259
1260
1261
# File 'generated/google/apis/drive_v3/classes.rb', line 1259

def version
  @version
end

#video_media_metadataGoogle::Apis::DriveV3::File::VideoMediaMetadata

Additional metadata about video media. This may not be available immediately upon upload. Corresponds to the JSON property videoMediaMetadata



1265
1266
1267
# File 'generated/google/apis/drive_v3/classes.rb', line 1265

def 
  @video_media_metadata
end

#viewed_by_meBoolean Also known as: viewed_by_me?

Whether the file has been viewed by this user. Corresponds to the JSON property viewedByMe

Returns:

  • (Boolean)


1270
1271
1272
# File 'generated/google/apis/drive_v3/classes.rb', line 1270

def viewed_by_me
  @viewed_by_me
end

#viewed_by_me_timeDateTime

The last time the file was viewed by the user (RFC 3339 date-time). Corresponds to the JSON property viewedByMeTime

Returns:

  • (DateTime)


1276
1277
1278
# File 'generated/google/apis/drive_v3/classes.rb', line 1276

def viewed_by_me_time
  @viewed_by_me_time
end

#viewers_can_copy_contentBoolean Also known as: viewers_can_copy_content?

Deprecated - use copyRequiresWriterPermission instead. Corresponds to the JSON property viewersCanCopyContent

Returns:

  • (Boolean)


1281
1282
1283
# File 'generated/google/apis/drive_v3/classes.rb', line 1281

def viewers_can_copy_content
  @viewers_can_copy_content
end

A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. Corresponds to the JSON property webContentLink

Returns:

  • (String)


1288
1289
1290
# File 'generated/google/apis/drive_v3/classes.rb', line 1288

def web_content_link
  @web_content_link
end

A link for opening the file in a relevant Google editor or viewer in a browser. Corresponds to the JSON property webViewLink

Returns:

  • (String)


1293
1294
1295
# File 'generated/google/apis/drive_v3/classes.rb', line 1293

def web_view_link
  @web_view_link
end

#writers_can_shareBoolean Also known as: writers_can_share?

Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. Corresponds to the JSON property writersCanShare

Returns:

  • (Boolean)


1299
1300
1301
# File 'generated/google/apis/drive_v3/classes.rb', line 1299

def writers_can_share
  @writers_can_share
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'generated/google/apis/drive_v3/classes.rb', line 1307

def update!(**args)
  @app_properties = args[:app_properties] if args.key?(:app_properties)
  @capabilities = args[:capabilities] if args.key?(:capabilities)
  @content_hints = args[:content_hints] if args.key?(:content_hints)
  @copy_requires_writer_permission = args[:copy_requires_writer_permission] if args.key?(:copy_requires_writer_permission)
  @created_time = args[:created_time] if args.key?(:created_time)
  @description = args[:description] if args.key?(:description)
  @drive_id = args[:drive_id] if args.key?(:drive_id)
  @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)
  @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)
  @is_app_authorized = args[:is_app_authorized] if args.key?(:is_app_authorized)
  @kind = args[:kind] if args.key?(:kind)
  @last_modifying_user = args[:last_modifying_user] if args.key?(:last_modifying_user)
  @md5_checksum = args[:md5_checksum] if args.key?(:md5_checksum)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @modified_by_me = args[:modified_by_me] if args.key?(:modified_by_me)
  @modified_by_me_time = args[:modified_by_me_time] if args.key?(:modified_by_me_time)
  @modified_time = args[:modified_time] if args.key?(:modified_time)
  @name = args[:name] if args.key?(:name)
  @original_filename = args[:original_filename] if args.key?(:original_filename)
  @owned_by_me = args[:owned_by_me] if args.key?(:owned_by_me)
  @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)
  @shared = args[:shared] if args.key?(:shared)
  @shared_with_me_time = args[:shared_with_me_time] if args.key?(:shared_with_me_time)
  @sharing_user = args[:sharing_user] if args.key?(:sharing_user)
  @shortcut_details = args[:shortcut_details] if args.key?(:shortcut_details)
  @size = args[:size] if args.key?(:size)
  @spaces = args[:spaces] if args.key?(:spaces)
  @starred = args[:starred] if args.key?(:starred)
  @team_drive_id = args[:team_drive_id] if args.key?(:team_drive_id)
  @thumbnail_link = args[:thumbnail_link] if args.key?(:thumbnail_link)
  @thumbnail_version = args[:thumbnail_version] if args.key?(:thumbnail_version)
  @trashed = args[:trashed] if args.key?(:trashed)
  @trashed_time = args[:trashed_time] if args.key?(:trashed_time)
  @trashing_user = args[:trashing_user] if args.key?(:trashing_user)
  @version = args[:version] if args.key?(:version)
  @video_media_metadata = args[:video_media_metadata] if args.key?(:video_media_metadata)
  @viewed_by_me = args[:viewed_by_me] if args.key?(:viewed_by_me)
  @viewed_by_me_time = args[:viewed_by_me_time] if args.key?(:viewed_by_me_time)
  @viewers_can_copy_content = args[:viewers_can_copy_content] if args.key?(:viewers_can_copy_content)
  @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