Class: Google::Apis::DriveV3::FileList

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

A list of files.

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

Returns a new instance of FileList



1418
1419
1420
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1418

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

Instance Attribute Details

#files ⇒ Array<Google::Apis::DriveV3::File>

The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. Corresponds to the JSON property files

Returns:



1391
1392
1393
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1391

def files
  @files
end

#incomplete_search ⇒ Boolean Also known as: incomplete_search?

Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple Team Drives with the "user,allTeamDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "user" or "teamDrive" . Corresponds to the JSON property incompleteSearch

Returns:

  • (Boolean) 


1401
1402
1403
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1401

def incomplete_search
  @incomplete_search
end

#kind ⇒ String

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

Returns:

  • (String) 


1408
1409
1410
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1408

def kind
  @kind
end

#next_page_token ⇒ String

The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


1416
1417
1418
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1416

def next_page_token
  @next_page_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1423
1424
1425
1426
1427
1428
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1423

def update!(**args)
  @files = args[:files] if args.key?(:files)
  @incomplete_search = args[:incomplete_search] if args.key?(:incomplete_search)
  @kind = args[:kind] if args.key?(:kind)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end