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



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

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


520
521
522
 
# File 'generated/google/apis/drive_v3/classes.rb', line 520

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:



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

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:



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

def content_hints
  @content_hints
end

#created_time ⇒ DateTime

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

Returns:

  • (DateTime) 


537
538
539
 
# File 'generated/google/apis/drive_v3/classes.rb', line 537

def created_time
  @created_time
end

#description ⇒ String

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

Returns:

  • (String) 


542
543
544
 
# File 'generated/google/apis/drive_v3/classes.rb', line 542

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) 


548
549
550
 
# File 'generated/google/apis/drive_v3/classes.rb', line 548

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


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

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) 


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

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) 


572
573
574
 
# File 'generated/google/apis/drive_v3/classes.rb', line 572

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) 


578
579
580
 
# File 'generated/google/apis/drive_v3/classes.rb', line 578

def has_augmented_permissions
  @has_augmented_permissions
end

#has_thumbnail ⇒ Boolean Also known as: has_thumbnail?

Whether this file has a thumbnail. Corresponds to the JSON property hasThumbnail

Returns:

  • (Boolean) 


584
585
586
 
# File 'generated/google/apis/drive_v3/classes.rb', line 584

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) 


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

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) 


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

def icon_link
  @icon_link
end

#id ⇒ String

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

Returns:

  • (String) 


601
602
603
 
# File 'generated/google/apis/drive_v3/classes.rb', line 601

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:



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

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) 


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

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) 


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

def kind
  @kind
end

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

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

Returns:



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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


656
657
658
 
# File 'generated/google/apis/drive_v3/classes.rb', line 656

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) 


663
664
665
 
# File 'generated/google/apis/drive_v3/classes.rb', line 663

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) 


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

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) 


675
676
677
 
# File 'generated/google/apis/drive_v3/classes.rb', line 675

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:



682
683
684
 
# File 'generated/google/apis/drive_v3/classes.rb', line 682

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 My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values. Corresponds to the JSON property parents

Returns:

  • (Array<String>) 


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

def parents
  @parents
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:



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

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


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

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) 


708
709
710
 
# File 'generated/google/apis/drive_v3/classes.rb', line 708

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) 


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

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) 


720
721
722
 
# File 'generated/google/apis/drive_v3/classes.rb', line 720

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:



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

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) 


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

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


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

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) 


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

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) 


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

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) 


755
756
757
 
# File 'generated/google/apis/drive_v3/classes.rb', line 755

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) 


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

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) 


767
768
769
 
# File 'generated/google/apis/drive_v3/classes.rb', line 767

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) 


774
775
776
 
# File 'generated/google/apis/drive_v3/classes.rb', line 774

def trashed_time
  @trashed_time
end

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

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

Returns:



779
780
781
 
# File 'generated/google/apis/drive_v3/classes.rb', line 779

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) 


785
786
787
 
# File 'generated/google/apis/drive_v3/classes.rb', line 785

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:



791
792
793
 
# File 'generated/google/apis/drive_v3/classes.rb', line 791

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) 


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

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) 


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

def viewed_by_me_time
  @viewed_by_me_time
end

#viewers_can_copy_content ⇒ Boolean Also known as: viewers_can_copy_content?

Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations. Corresponds to the JSON property viewersCanCopyContent

Returns:

  • (Boolean) 


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

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) 


815
816
817
 
# File 'generated/google/apis/drive_v3/classes.rb', line 815

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) 


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

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) 


826
827
828
 
# File 'generated/google/apis/drive_v3/classes.rb', line 826

def writers_can_share
  @writers_can_share
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
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
 
# File 'generated/google/apis/drive_v3/classes.rb', line 834

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