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

Constructor Details

#initialize(**args) ⇒ File

Returns a new instance of File.



1363
1364
1365
# File 'generated/google/apis/drive_v3/classes.rb', line 1363

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

Returns:

  • (Hash<String,String>)


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

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



1019
1020
1021
# File 'generated/google/apis/drive_v3/classes.rb', line 1019

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



1025
1026
1027
# File 'generated/google/apis/drive_v3/classes.rb', line 1025

def content_hints
  @content_hints
end

#content_restrictionsArray<Google::Apis::DriveV3::ContentRestriction>

Restrictions for accessing the content of the file. Only populated if such a restriction exists. Corresponds to the JSON property contentRestrictions



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

def content_restrictions
  @content_restrictions
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)


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

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)


1043
1044
1045
# File 'generated/google/apis/drive_v3/classes.rb', line 1043

def created_time
  @created_time
end

#descriptionString

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

Returns:

  • (String)


1048
1049
1050
# File 'generated/google/apis/drive_v3/classes.rb', line 1048

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)


1054
1055
1056
# File 'generated/google/apis/drive_v3/classes.rb', line 1054

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)


1060
1061
1062
# File 'generated/google/apis/drive_v3/classes.rb', line 1060

def explicitly_trashed
  @explicitly_trashed
end

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

Returns:

  • (Hash<String,String>)


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

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)


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

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)


1080
1081
1082
# File 'generated/google/apis/drive_v3/classes.rb', line 1080

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)


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

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)


1095
1096
1097
# File 'generated/google/apis/drive_v3/classes.rb', line 1095

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)


1103
1104
1105
# File 'generated/google/apis/drive_v3/classes.rb', line 1103

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)


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

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)


1115
1116
1117
# File 'generated/google/apis/drive_v3/classes.rb', line 1115

def icon_link
  @icon_link
end

#idString

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

Returns:

  • (String)


1120
1121
1122
# File 'generated/google/apis/drive_v3/classes.rb', line 1120

def id
  @id
end

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

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



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

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)


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

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)


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

def kind
  @kind
end

#last_modifying_userGoogle::Apis::DriveV3::User

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



1141
1142
1143
# File 'generated/google/apis/drive_v3/classes.rb', line 1141

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)


1147
1148
1149
# File 'generated/google/apis/drive_v3/classes.rb', line 1147

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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:



1201
1202
1203
# File 'generated/google/apis/drive_v3/classes.rb', line 1201

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>)


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

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>)


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

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



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

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>)


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

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)


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

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)


1239
1240
1241
# File 'generated/google/apis/drive_v3/classes.rb', line 1239

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)


1246
1247
1248
# File 'generated/google/apis/drive_v3/classes.rb', line 1246

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



1251
1252
1253
# File 'generated/google/apis/drive_v3/classes.rb', line 1251

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



1257
1258
1259
# File 'generated/google/apis/drive_v3/classes.rb', line 1257

def shortcut_details
  @shortcut_details
end

#sizeFixnum

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

Returns:

  • (Fixnum)


1263
1264
1265
# File 'generated/google/apis/drive_v3/classes.rb', line 1263

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>)


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

def spaces
  @spaces
end

#starredBoolean Also known as: starred?

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

Returns:

  • (Boolean)


1274
1275
1276
# File 'generated/google/apis/drive_v3/classes.rb', line 1274

def starred
  @starred
end

#team_drive_idString

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

Returns:

  • (String)


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

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. 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

Returns:

  • (String)


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

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)


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

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

Returns:

  • (Boolean)


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

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)


1309
1310
1311
# File 'generated/google/apis/drive_v3/classes.rb', line 1309

def trashed_time
  @trashed_time
end

#trashing_userGoogle::Apis::DriveV3::User

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



1314
1315
1316
# File 'generated/google/apis/drive_v3/classes.rb', line 1314

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)


1320
1321
1322
# File 'generated/google/apis/drive_v3/classes.rb', line 1320

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



1326
1327
1328
# File 'generated/google/apis/drive_v3/classes.rb', line 1326

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)


1331
1332
1333
# File 'generated/google/apis/drive_v3/classes.rb', line 1331

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)


1337
1338
1339
# File 'generated/google/apis/drive_v3/classes.rb', line 1337

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)


1342
1343
1344
# File 'generated/google/apis/drive_v3/classes.rb', line 1342

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)


1349
1350
1351
# File 'generated/google/apis/drive_v3/classes.rb', line 1349

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)


1354
1355
1356
# File 'generated/google/apis/drive_v3/classes.rb', line 1354

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)


1360
1361
1362
# File 'generated/google/apis/drive_v3/classes.rb', line 1360

def writers_can_share
  @writers_can_share
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
# File 'generated/google/apis/drive_v3/classes.rb', line 1368

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)
  @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)
  @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