Class: Google::Apis::DriveV2::FileList

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/drive_v2/classes.rb,
generated/google/apis/drive_v2/representations.rb,
generated/google/apis/drive_v2/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



2323
2324
2325
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2323

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

Instance Attribute Details

#etag ⇒ String

The ETag of the list. Corresponds to the JSON property etag

Returns:

  • (String) 


2281
2282
2283
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2281

def etag
  @etag
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 "default,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 "default" or "teamDrive". Corresponds to the JSON property incompleteSearch

Returns:

  • (Boolean) 


2291
2292
2293
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2291

def incomplete_search
  @incomplete_search
end

#items ⇒ Array<Google::Apis::DriveV2::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 items

Returns:



2298
2299
2300
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2298

def items
  @items
end

#kind ⇒ String

This is always drive#fileList. Corresponds to the JSON property kind

Returns:

  • (String) 


2303
2304
2305
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2303

def kind
  @kind
end

#next_link ⇒ String

A link to the next page of files. Corresponds to the JSON property nextLink

Returns:

  • (String) 


2308
2309
2310
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2308

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


2316
2317
2318
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2316

def next_page_token
  @next_page_token
end

#self_link ⇒ String

A link back to this list. Corresponds to the JSON property selfLink

Returns:

  • (String) 


2321
2322
2323
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2321

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2328

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