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.


2026
2027
2028
# File 'generated/google/apis/drive_v3/classes.rb', line 2026

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

Instance Attribute Details

#filesArray<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:


2000
2001
2002
# File 'generated/google/apis/drive_v3/classes.rb', line 2000

def files
  @files
end

#incomplete_searchBoolean 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 drives with the "allDrives" 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 "drive". Corresponds to the JSON property incompleteSearch

Returns:

  • (Boolean)

2009
2010
2011
# File 'generated/google/apis/drive_v3/classes.rb', line 2009

def incomplete_search
  @incomplete_search
end

#kindString

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

Returns:

  • (String)

2016
2017
2018
# File 'generated/google/apis/drive_v3/classes.rb', line 2016

def kind
  @kind
end

#next_page_tokenString

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)

2024
2025
2026
# File 'generated/google/apis/drive_v3/classes.rb', line 2024

def next_page_token
  @next_page_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2031
2032
2033
2034
2035
2036
# File 'generated/google/apis/drive_v3/classes.rb', line 2031

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