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.



3098
3099
3100
# File 'lib/google/apis/drive_v2/classes.rb', line 3098

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

Instance Attribute Details

#etagString

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

Returns:

  • (String)


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

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)


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

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:



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

def items
  @items
end

#kindString

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

Returns:

  • (String)


3078
3079
3080
# File 'lib/google/apis/drive_v2/classes.rb', line 3078

def kind
  @kind
end

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

Returns:

  • (String)


3083
3084
3085
# File 'lib/google/apis/drive_v2/classes.rb', line 3083

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)


3091
3092
3093
# File 'lib/google/apis/drive_v2/classes.rb', line 3091

def next_page_token
  @next_page_token
end

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

Returns:

  • (String)


3096
3097
3098
# File 'lib/google/apis/drive_v2/classes.rb', line 3096

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'lib/google/apis/drive_v2/classes.rb', line 3103

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