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



2239
2240
2241
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2239

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

Instance Attribute Details

#etag ⇒ String

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

Returns:

  • (String) 


2197
2198
2199
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2197

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) 


2207
2208
2209
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2207

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:



2214
2215
2216
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2214

def items
  @items
end

#kind ⇒ String

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

Returns:

  • (String) 


2219
2220
2221
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2219

def kind
  @kind
end

#next_link ⇒ String

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

Returns:

  • (String) 


2224
2225
2226
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2224

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) 


2232
2233
2234
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2232

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) 


2237
2238
2239
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2237

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2244
2245
2246
2247
2248
2249
2250
2251
2252
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2244

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