public class Books.Bookshelves.Volumes.List extends BooksRequest<Volumes>
GenericData.FlagsAbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>USER_AGENT_SUFFIX| Modifier | Constructor and Description |
|---|---|
protected |
List(String userId,
String shelf)
Retrieves volumes in a specific bookshelf for the specified user.
|
| Modifier and Type | Method and Description |
|---|---|
HttpRequest |
buildHttpRequestUsingHead() |
HttpResponse |
executeUsingHead() |
Long |
getMaxResults()
Maximum number of results to return
[minimum: 0]
|
String |
getShelf()
ID of bookshelf to retrieve volumes.
|
Boolean |
getShowPreorders()
Set to true to show pre-ordered books.
|
String |
getSource()
String to identify the originator of this request.
|
Long |
getStartIndex()
Index of the first element to return (starts at 0)
[minimum: 0]
|
String |
getUserId()
ID of user for whom to retrieve bookshelf volumes.
|
Books.Bookshelves.Volumes.List |
set(String parameterName,
Object value) |
Books.Bookshelves.Volumes.List |
set$Xgafv(String $Xgafv)
V1 error format.
|
Books.Bookshelves.Volumes.List |
setAccessToken(String accessToken)
OAuth access token.
|
Books.Bookshelves.Volumes.List |
setAlt(String alt)
Data format for response.
|
Books.Bookshelves.Volumes.List |
setCallback(String callback)
JSONP
|
Books.Bookshelves.Volumes.List |
setFields(String fields)
Selector specifying which fields to include in a partial response.
|
Books.Bookshelves.Volumes.List |
setKey(String key)
API key.
|
Books.Bookshelves.Volumes.List |
setMaxResults(Long maxResults)
Maximum number of results to return
|
Books.Bookshelves.Volumes.List |
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
|
Books.Bookshelves.Volumes.List |
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Books.Bookshelves.Volumes.List |
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
|
Books.Bookshelves.Volumes.List |
setShelf(String shelf)
ID of bookshelf to retrieve volumes.
|
Books.Bookshelves.Volumes.List |
setShowPreorders(Boolean showPreorders)
Set to true to show pre-ordered books.
|
Books.Bookshelves.Volumes.List |
setSource(String source)
String to identify the originator of this request.
|
Books.Bookshelves.Volumes.List |
setStartIndex(Long startIndex)
Index of the first element to return (starts at 0)
|
Books.Bookshelves.Volumes.List |
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
|
Books.Bookshelves.Volumes.List |
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
|
Books.Bookshelves.Volumes.List |
setUserId(String userId)
ID of user for whom to retrieve bookshelf volumes.
|
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeadersgetJsonContent, newExceptionOnError, queuebuildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStreamclone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toStringclear, containsKey, containsValue, isEmpty, keySet, size, valuesfinalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllprotected List(String userId, String shelf)
AbstractGoogleClientRequest.execute() method to invoke the remote operation. Books.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be
called to initialize this instance immediately after invoking the constructor.
userId - ID of user for whom to retrieve bookshelf volumes.shelf - ID of bookshelf to retrieve volumes.public HttpResponse executeUsingHead() throws IOException
executeUsingHead in class AbstractGoogleClientRequest<Volumes>IOExceptionpublic HttpRequest buildHttpRequestUsingHead() throws IOException
buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Volumes>IOExceptionpublic Books.Bookshelves.Volumes.List set$Xgafv(String $Xgafv)
BooksRequestset$Xgafv in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setAccessToken(String accessToken)
BooksRequestsetAccessToken in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setAlt(String alt)
BooksRequestsetAlt in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setCallback(String callback)
BooksRequestsetCallback in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setFields(String fields)
BooksRequestsetFields in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setKey(String key)
BooksRequestsetKey in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setOauthToken(String oauthToken)
BooksRequestsetOauthToken in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setPrettyPrint(Boolean prettyPrint)
BooksRequestsetPrettyPrint in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setQuotaUser(String quotaUser)
BooksRequestsetQuotaUser in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setUploadType(String uploadType)
BooksRequestsetUploadType in class BooksRequest<Volumes>public Books.Bookshelves.Volumes.List setUploadProtocol(String uploadProtocol)
BooksRequestsetUploadProtocol in class BooksRequest<Volumes>public String getUserId()
public Books.Bookshelves.Volumes.List setUserId(String userId)
public String getShelf()
public Books.Bookshelves.Volumes.List setShelf(String shelf)
public Long getMaxResults()
public Books.Bookshelves.Volumes.List setMaxResults(Long maxResults)
public Boolean getShowPreorders()
public Books.Bookshelves.Volumes.List setShowPreorders(Boolean showPreorders)
public String getSource()
public Books.Bookshelves.Volumes.List setSource(String source)
public Long getStartIndex()
public Books.Bookshelves.Volumes.List setStartIndex(Long startIndex)
public Books.Bookshelves.Volumes.List set(String parameterName, Object value)
set in class BooksRequest<Volumes>Copyright © 2011–2020 Google. All rights reserved.