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.



2856
2857
2858
# File 'generated/google/apis/drive_v2/classes.rb', line 2856

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

Instance Attribute Details

#etagString

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

Returns:

  • (String)


2815
2816
2817
# File 'generated/google/apis/drive_v2/classes.rb', line 2815

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

Returns:

  • (Boolean)


2824
2825
2826
# File 'generated/google/apis/drive_v2/classes.rb', line 2824

def incomplete_search
  @incomplete_search
end

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



2831
2832
2833
# File 'generated/google/apis/drive_v2/classes.rb', line 2831

def items
  @items
end

#kindString

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

Returns:

  • (String)


2836
2837
2838
# File 'generated/google/apis/drive_v2/classes.rb', line 2836

def kind
  @kind
end

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

Returns:

  • (String)


2841
2842
2843
# File 'generated/google/apis/drive_v2/classes.rb', line 2841

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


2849
2850
2851
# File 'generated/google/apis/drive_v2/classes.rb', line 2849

def next_page_token
  @next_page_token
end

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

Returns:

  • (String)


2854
2855
2856
# File 'generated/google/apis/drive_v2/classes.rb', line 2854

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2861
2862
2863
2864
2865
2866
2867
2868
2869
# File 'generated/google/apis/drive_v2/classes.rb', line 2861

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