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.



2804
2805
2806
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2804

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

Instance Attribute Details

#etag ⇒ String

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

Returns:

  • (String) 


2763
2764
2765
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2763

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 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 "default" or "drive". Corresponds to the JSON property incompleteSearch

Returns:

  • (Boolean) 


2772
2773
2774
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2772

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:



2779
2780
2781
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2779

def items
  @items
end

#kind ⇒ String

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

Returns:

  • (String) 


2784
2785
2786
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2784

def kind
  @kind
end

#next_link ⇒ String

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

Returns:

  • (String) 


2789
2790
2791
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2789

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) 


2797
2798
2799
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2797

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) 


2802
2803
2804
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2802

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2809
2810
2811
2812
2813
2814
2815
2816
2817
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2809

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