com.google.api.services.drive.model.FileList Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.drive.model;
/**
* A list of files.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Google Drive API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class FileList extends com.google.api.client.json.GenericJson {
/**
* The list of files. If nextPageToken is populated, then this list may be incomplete and an
* additional page of results should be fetched.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List files;
static {
// hack to force ProGuard to consider File used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(File.class);
}
/**
* Whether the search process was incomplete. If true, then some search results might be missing,
* since all documents were not searched. This can occur when searching multiple drives with the
* 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested
* that clients narrow their query by choosing a different corpus such as 'user' or 'drive'.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean incompleteSearch;
/**
* Identifies what kind of resource this is. Value: the fixed string `"drive#fileList"`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* 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. The page token is typically valid for
* several hours. However, if new items are added or removed, your expected results might differ.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String nextPageToken;
/**
* The list of files. If nextPageToken is populated, then this list may be incomplete and an
* additional page of results should be fetched.
* @return value or {@code null} for none
*/
public java.util.List getFiles() {
return files;
}
/**
* The list of files. If nextPageToken is populated, then this list may be incomplete and an
* additional page of results should be fetched.
* @param files files or {@code null} for none
*/
public FileList setFiles(java.util.List files) {
this.files = files;
return this;
}
/**
* Whether the search process was incomplete. If true, then some search results might be missing,
* since all documents were not searched. This can occur when searching multiple drives with the
* 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested
* that clients narrow their query by choosing a different corpus such as 'user' or 'drive'.
* @return value or {@code null} for none
*/
public java.lang.Boolean getIncompleteSearch() {
return incompleteSearch;
}
/**
* Whether the search process was incomplete. If true, then some search results might be missing,
* since all documents were not searched. This can occur when searching multiple drives with the
* 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested
* that clients narrow their query by choosing a different corpus such as 'user' or 'drive'.
* @param incompleteSearch incompleteSearch or {@code null} for none
*/
public FileList setIncompleteSearch(java.lang.Boolean incompleteSearch) {
this.incompleteSearch = incompleteSearch;
return this;
}
/**
* Identifies what kind of resource this is. Value: the fixed string `"drive#fileList"`.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* Identifies what kind of resource this is. Value: the fixed string `"drive#fileList"`.
* @param kind kind or {@code null} for none
*/
public FileList setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* 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. The page token is typically valid for
* several hours. However, if new items are added or removed, your expected results might differ.
* @return value or {@code null} for none
*/
public java.lang.String getNextPageToken() {
return nextPageToken;
}
/**
* 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. The page token is typically valid for
* several hours. However, if new items are added or removed, your expected results might differ.
* @param nextPageToken nextPageToken or {@code null} for none
*/
public FileList setNextPageToken(java.lang.String nextPageToken) {
this.nextPageToken = nextPageToken;
return this;
}
@Override
public FileList set(String fieldName, Object value) {
return (FileList) super.set(fieldName, value);
}
@Override
public FileList clone() {
return (FileList) super.clone();
}
}