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



856
857
858
 
# File 'generated/google/apis/drive_v3/classes.rb', line 856

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

Instance Attribute Details

#app_properties ⇒ Hash<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>) 


527
528
529
 
# File 'generated/google/apis/drive_v3/classes.rb', line 527

def app_properties
  @app_properties
end

#capabilities ⇒ Google::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

Returns:



533
534
535
 
# File 'generated/google/apis/drive_v3/classes.rb', line 533

def capabilities
  @capabilities
end

#content_hints ⇒ Google::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

Returns:



539
540
541
 
# File 'generated/google/apis/drive_v3/classes.rb', line 539

def content_hints
  @content_hints
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

Returns:

  • (Boolean) 


545
546
547
 
# File 'generated/google/apis/drive_v3/classes.rb', line 545

def copy_requires_writer_permission
  @copy_requires_writer_permission
end

#created_time ⇒ DateTime

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

Returns:

  • (DateTime) 


551
552
553
 
# File 'generated/google/apis/drive_v3/classes.rb', line 551

def created_time
  @created_time
end

#description ⇒ String

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

Returns:

  • (String) 


556
557
558
 
# File 'generated/google/apis/drive_v3/classes.rb', line 556

def description
  @description
end

#explicitly_trashed ⇒ Boolean 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) 


562
563
564
 
# File 'generated/google/apis/drive_v3/classes.rb', line 562

def explicitly_trashed
  @explicitly_trashed
end

#export_links ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


568
569
570
 
# File 'generated/google/apis/drive_v3/classes.rb', line 568

def export_links
  @export_links
end

#file_extension ⇒ String

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

Returns:

  • (String) 


574
575
576
 
# File 'generated/google/apis/drive_v3/classes.rb', line 574

def file_extension
  @file_extension
end

#folder_color_rgb ⇒ String

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) 


582
583
584
 
# File 'generated/google/apis/drive_v3/classes.rb', line 582

def folder_color_rgb
  @folder_color_rgb
end

#full_file_extension ⇒ String

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


591
592
593
 
# File 'generated/google/apis/drive_v3/classes.rb', line 591

def full_file_extension
  @full_file_extension
end

#has_augmented_permissions ⇒ Boolean Also known as: has_augmented_permissions?

Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. Corresponds to the JSON property hasAugmentedPermissions

Returns:

  • (Boolean) 


597
598
599
 
# File 'generated/google/apis/drive_v3/classes.rb', line 597

def has_augmented_permissions
  @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

Returns:

  • (Boolean) 


605
606
607
 
# File 'generated/google/apis/drive_v3/classes.rb', line 605

def has_thumbnail
  @has_thumbnail
end

#head_revision_id ⇒ String

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

Returns:

  • (String) 


612
613
614
 
# File 'generated/google/apis/drive_v3/classes.rb', line 612

def head_revision_id
  @head_revision_id
end

#icon_link ⇒ String

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

Returns:

  • (String) 


617
618
619
 
# File 'generated/google/apis/drive_v3/classes.rb', line 617

def icon_link
  @icon_link
end

#id ⇒ String

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

Returns:

  • (String) 


622
623
624
 
# File 'generated/google/apis/drive_v3/classes.rb', line 622

def id
  @id
end

#image_media_metadata ⇒ Google::Apis::DriveV3::File::ImageMediaMetadata

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

Returns:



627
628
629
 
# File 'generated/google/apis/drive_v3/classes.rb', line 627

def image_media_metadata
  @image_media_metadata
end

#is_app_authorized ⇒ Boolean 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) 


632
633
634
 
# File 'generated/google/apis/drive_v3/classes.rb', line 632

def is_app_authorized
  @is_app_authorized
end

#kind ⇒ String

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

Returns:

  • (String) 


638
639
640
 
# File 'generated/google/apis/drive_v3/classes.rb', line 638

def kind
  @kind
end

#last_modifying_user ⇒ Google::Apis::DriveV3::User

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

Returns:



643
644
645
 
# File 'generated/google/apis/drive_v3/classes.rb', line 643

def last_modifying_user
  @last_modifying_user
end

#md5_checksum ⇒ String

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

Returns:

  • (String) 


649
650
651
 
# File 'generated/google/apis/drive_v3/classes.rb', line 649

def md5_checksum
  @md5_checksum
end

#mime_type ⇒ String

The MIME type of the file. 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) 


660
661
662
 
# File 'generated/google/apis/drive_v3/classes.rb', line 660

def mime_type
  @mime_type
end

#modified_by_me ⇒ Boolean Also known as: modified_by_me?

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

Returns:

  • (Boolean) 


665
666
667
 
# File 'generated/google/apis/drive_v3/classes.rb', line 665

def modified_by_me
  @modified_by_me
end

#modified_by_me_time ⇒ DateTime

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

Returns:

  • (DateTime) 


671
672
673
 
# File 'generated/google/apis/drive_v3/classes.rb', line 671

def modified_by_me_time
  @modified_by_me_time
end

#modified_time ⇒ DateTime

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) 


677
678
679
 
# File 'generated/google/apis/drive_v3/classes.rb', line 677

def modified_time
  @modified_time
end

#name ⇒ String

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 Team Drives, My Drive root folder, and Application Data folder the name is constant. Corresponds to the JSON property name

Returns:

  • (String) 


684
685
686
 
# File 'generated/google/apis/drive_v3/classes.rb', line 684

def name
  @name
end

#original_filename ⇒ String

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

Returns:

  • (String) 


691
692
693
 
# File 'generated/google/apis/drive_v3/classes.rb', line 691

def original_filename
  @original_filename
end

#owned_by_me ⇒ Boolean Also known as: owned_by_me?

Whether the user owns the file. Not populated for Team Drive files. Corresponds to the JSON property ownedByMe

Returns:

  • (Boolean) 


696
697
698
 
# File 'generated/google/apis/drive_v3/classes.rb', line 696

def owned_by_me
  @owned_by_me
end

#owners ⇒ Array<Google::Apis::DriveV3::User>

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

Returns:



703
704
705
 
# File 'generated/google/apis/drive_v3/classes.rb', line 703

def owners
  @owners
end

#parents ⇒ Array<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>) 


713
714
715
 
# File 'generated/google/apis/drive_v3/classes.rb', line 713

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

Returns:

  • (Array<String>) 


718
719
720
 
# File 'generated/google/apis/drive_v3/classes.rb', line 718

def permission_ids
  @permission_ids
end

#permissions ⇒ Array<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 Team Drive files. Corresponds to the JSON property permissions

Returns:



724
725
726
 
# File 'generated/google/apis/drive_v3/classes.rb', line 724

def permissions
  @permissions
end

#properties ⇒ Hash<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>) 


730
731
732
 
# File 'generated/google/apis/drive_v3/classes.rb', line 730

def properties
  @properties
end

#quota_bytes_used ⇒ Fixnum

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) 


736
737
738
 
# File 'generated/google/apis/drive_v3/classes.rb', line 736

def quota_bytes_used
  @quota_bytes_used
end

#shared ⇒ Boolean Also known as: shared?

Whether the file has been shared. Not populated for Team Drive files. Corresponds to the JSON property shared

Returns:

  • (Boolean) 


741
742
743
 
# File 'generated/google/apis/drive_v3/classes.rb', line 741

def shared
  @shared
end

#shared_with_me_time ⇒ DateTime

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) 


748
749
750
 
# File 'generated/google/apis/drive_v3/classes.rb', line 748

def shared_with_me_time
  @shared_with_me_time
end

#sharing_user ⇒ Google::Apis::DriveV3::User

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

Returns:



753
754
755
 
# File 'generated/google/apis/drive_v3/classes.rb', line 753

def sharing_user
  @sharing_user
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


759
760
761
 
# File 'generated/google/apis/drive_v3/classes.rb', line 759

def size
  @size
end

#spaces ⇒ Array<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>) 


765
766
767
 
# File 'generated/google/apis/drive_v3/classes.rb', line 765

def spaces
  @spaces
end

#starred ⇒ Boolean Also known as: starred?

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

Returns:

  • (Boolean) 


770
771
772
 
# File 'generated/google/apis/drive_v3/classes.rb', line 770

def starred
  @starred
end

#team_drive_id ⇒ String

ID of the Team Drive the file resides in. Corresponds to the JSON property teamDriveId

Returns:

  • (String) 


776
777
778
 
# File 'generated/google/apis/drive_v3/classes.rb', line 776

def team_drive_id
  @team_drive_id
end

#thumbnail_link ⇒ String

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) 


783
784
785
 
# File 'generated/google/apis/drive_v3/classes.rb', line 783

def thumbnail_link
  @thumbnail_link
end

#thumbnail_version ⇒ Fixnum

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

Returns:

  • (Fixnum) 


788
789
790
 
# File 'generated/google/apis/drive_v3/classes.rb', line 788

def thumbnail_version
  @thumbnail_version
end

#trashed ⇒ Boolean 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) 


795
796
797
 
# File 'generated/google/apis/drive_v3/classes.rb', line 795

def trashed
  @trashed
end

#trashed_time ⇒ DateTime

The time that the item was trashed (RFC 3339 date-time). Only populated for Team Drive files. Corresponds to the JSON property trashedTime

Returns:

  • (DateTime) 


802
803
804
 
# File 'generated/google/apis/drive_v3/classes.rb', line 802

def trashed_time
  @trashed_time
end

#trashing_user ⇒ Google::Apis::DriveV3::User

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

Returns:



807
808
809
 
# File 'generated/google/apis/drive_v3/classes.rb', line 807

def trashing_user
  @trashing_user
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 user. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


813
814
815
 
# File 'generated/google/apis/drive_v3/classes.rb', line 813

def version
  @version
end

#video_media_metadata ⇒ Google::Apis::DriveV3::File::VideoMediaMetadata

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

Returns:



819
820
821
 
# File 'generated/google/apis/drive_v3/classes.rb', line 819

def video_media_metadata
  @video_media_metadata
end

#viewed_by_me ⇒ Boolean Also known as: viewed_by_me?

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

Returns:

  • (Boolean) 


824
825
826
 
# File 'generated/google/apis/drive_v3/classes.rb', line 824

def viewed_by_me
  @viewed_by_me
end

#viewed_by_me_time ⇒ DateTime

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

Returns:

  • (DateTime) 


830
831
832
 
# File 'generated/google/apis/drive_v3/classes.rb', line 830

def viewed_by_me_time
  @viewed_by_me_time
end

#viewers_can_copy_content ⇒ Boolean Also known as: viewers_can_copy_content?

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

Returns:

  • (Boolean) 


835
836
837
 
# File 'generated/google/apis/drive_v3/classes.rb', line 835

def viewers_can_copy_content
  @viewers_can_copy_content
end

#web_content_link ⇒ String

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

Returns:

  • (String) 


842
843
844
 
# File 'generated/google/apis/drive_v3/classes.rb', line 842

def web_content_link
  @web_content_link
end

#web_view_link ⇒ String

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

Returns:

  • (String) 


847
848
849
 
# File 'generated/google/apis/drive_v3/classes.rb', line 847

def web_view_link
  @web_view_link
end

#writers_can_share ⇒ Boolean Also known as: writers_can_share?

Whether users with only writer permission can modify the file's permissions. Not populated for Team Drive files. Corresponds to the JSON property writersCanShare

Returns:

  • (Boolean) 


853
854
855
 
# File 'generated/google/apis/drive_v3/classes.rb', line 853

def writers_can_share
  @writers_can_share
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
# File 'generated/google/apis/drive_v3/classes.rb', line 861

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