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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/drive_v2/classes.rb,
lib/google/apis/drive_v2/representations.rb,
lib/google/apis/drive_v2/representations.rb

Overview

A list of files.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FileList

Returns a new instance of FileList.



3072
3073
3074
# File 'lib/google/apis/drive_v2/classes.rb', line 3072

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

Instance Attribute Details

#etagString

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

Returns:

  • (String)


3031
3032
3033
# File 'lib/google/apis/drive_v2/classes.rb', line 3031

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)


3040
3041
3042
# File 'lib/google/apis/drive_v2/classes.rb', line 3040

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:



3047
3048
3049
# File 'lib/google/apis/drive_v2/classes.rb', line 3047

def items
  @items
end

#kindString

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

Returns:

  • (String)


3052
3053
3054
# File 'lib/google/apis/drive_v2/classes.rb', line 3052

def kind
  @kind
end

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

Returns:

  • (String)


3057
3058
3059
# File 'lib/google/apis/drive_v2/classes.rb', line 3057

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)


3065
3066
3067
# File 'lib/google/apis/drive_v2/classes.rb', line 3065

def next_page_token
  @next_page_token
end

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

Returns:

  • (String)


3070
3071
3072
# File 'lib/google/apis/drive_v2/classes.rb', line 3070

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3077
3078
3079
3080
3081
3082
3083
3084
3085
# File 'lib/google/apis/drive_v2/classes.rb', line 3077

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