public class Books.Layers.VolumeAnnotations.List extends BooksRequest<Volumeannotations>
com.google.api.client.util.GenericData.FlagsAbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>| Modifier | Constructor and Description |
|---|---|
protected |
List(String volumeId,
String layerId,
String contentVersion)
Gets the volume annotations for a volume and layer.
|
| Modifier and Type | Method and Description |
|---|---|
com.google.api.client.http.HttpRequest |
buildHttpRequestUsingHead() |
com.google.api.client.http.HttpResponse |
executeUsingHead() |
String |
getContentVersion()
The content version for the requested volume.
|
String |
getEndOffset()
The end offset to end retrieving data from.
|
String |
getEndPosition()
The end position to end retrieving data from.
|
String |
getLayerId()
The ID for the layer to get the annotations.
|
String |
getLocale()
The locale information for the data.
|
Long |
getMaxResults()
Maximum number of results to return
[minimum: 0] [maximum: 200]
|
String |
getPageToken()
The value of the nextToken from the previous page.
|
Boolean |
getShowDeleted()
Set to true to return deleted annotations.
|
String |
getSource()
String to identify the originator of this request.
|
String |
getStartOffset()
The start offset to start retrieving data from.
|
String |
getStartPosition()
The start position to start retrieving data from.
|
String |
getUpdatedMax()
RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
|
String |
getUpdatedMin()
RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
|
String |
getVolumeAnnotationsVersion()
The version of the volume annotations that you are requesting.
|
String |
getVolumeId()
The volume to retrieve annotations for.
|
Books.Layers.VolumeAnnotations.List |
set(String parameterName,
Object value) |
Books.Layers.VolumeAnnotations.List |
setAlt(String alt)
Data format for the response.
|
Books.Layers.VolumeAnnotations.List |
setContentVersion(String contentVersion)
The content version for the requested volume.
|
Books.Layers.VolumeAnnotations.List |
setEndOffset(String endOffset)
The end offset to end retrieving data from.
|
Books.Layers.VolumeAnnotations.List |
setEndPosition(String endPosition)
The end position to end retrieving data from.
|
Books.Layers.VolumeAnnotations.List |
setFields(String fields)
Selector specifying which fields to include in a partial response.
|
Books.Layers.VolumeAnnotations.List |
setKey(String key)
API key.
|
Books.Layers.VolumeAnnotations.List |
setLayerId(String layerId)
The ID for the layer to get the annotations.
|
Books.Layers.VolumeAnnotations.List |
setLocale(String locale)
The locale information for the data.
|
Books.Layers.VolumeAnnotations.List |
setMaxResults(Long maxResults)
Maximum number of results to return
|
Books.Layers.VolumeAnnotations.List |
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
|
Books.Layers.VolumeAnnotations.List |
setPageToken(String pageToken)
The value of the nextToken from the previous page.
|
Books.Layers.VolumeAnnotations.List |
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Books.Layers.VolumeAnnotations.List |
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
|
Books.Layers.VolumeAnnotations.List |
setShowDeleted(Boolean showDeleted)
Set to true to return deleted annotations.
|
Books.Layers.VolumeAnnotations.List |
setSource(String source)
String to identify the originator of this request.
|
Books.Layers.VolumeAnnotations.List |
setStartOffset(String startOffset)
The start offset to start retrieving data from.
|
Books.Layers.VolumeAnnotations.List |
setStartPosition(String startPosition)
The start position to start retrieving data from.
|
Books.Layers.VolumeAnnotations.List |
setUpdatedMax(String updatedMax)
RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
|
Books.Layers.VolumeAnnotations.List |
setUpdatedMin(String updatedMin)
RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
|
Books.Layers.VolumeAnnotations.List |
setUserIp(String userIp)
Deprecated.
|
Books.Layers.VolumeAnnotations.List |
setVolumeAnnotationsVersion(String volumeAnnotationsVersion)
The version of the volume annotations that you are requesting.
|
Books.Layers.VolumeAnnotations.List |
setVolumeId(String volumeId)
The volume to retrieve annotations for.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeadersgetJsonContent, newExceptionOnError, queuebuildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queueclone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeysclear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, valuesfinalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllprotected List(String volumeId, String layerId, String contentVersion)
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.
volumeId - The volume to retrieve annotations for.layerId - The ID for the layer to get the annotations.contentVersion - The content version for the requested volume.public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Volumeannotations>IOExceptionpublic com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Volumeannotations>IOExceptionpublic Books.Layers.VolumeAnnotations.List setAlt(String alt)
BooksRequestsetAlt in class BooksRequest<Volumeannotations>public Books.Layers.VolumeAnnotations.List setFields(String fields)
BooksRequestsetFields in class BooksRequest<Volumeannotations>public Books.Layers.VolumeAnnotations.List setKey(String key)
BooksRequestsetKey in class BooksRequest<Volumeannotations>public Books.Layers.VolumeAnnotations.List setOauthToken(String oauthToken)
BooksRequestsetOauthToken in class BooksRequest<Volumeannotations>public Books.Layers.VolumeAnnotations.List setPrettyPrint(Boolean prettyPrint)
BooksRequestsetPrettyPrint in class BooksRequest<Volumeannotations>public Books.Layers.VolumeAnnotations.List setQuotaUser(String quotaUser)
BooksRequestsetQuotaUser in class BooksRequest<Volumeannotations>public Books.Layers.VolumeAnnotations.List setUserIp(String userIp)
BooksRequestsetUserIp in class BooksRequest<Volumeannotations>public String getVolumeId()
public Books.Layers.VolumeAnnotations.List setVolumeId(String volumeId)
public String getLayerId()
public Books.Layers.VolumeAnnotations.List setLayerId(String layerId)
public String getContentVersion()
public Books.Layers.VolumeAnnotations.List setContentVersion(String contentVersion)
public String getEndOffset()
public Books.Layers.VolumeAnnotations.List setEndOffset(String endOffset)
public String getEndPosition()
public Books.Layers.VolumeAnnotations.List setEndPosition(String endPosition)
public String getLocale()
public Books.Layers.VolumeAnnotations.List setLocale(String locale)
public Long getMaxResults()
public Books.Layers.VolumeAnnotations.List setMaxResults(Long maxResults)
public String getPageToken()
public Books.Layers.VolumeAnnotations.List setPageToken(String pageToken)
public Boolean getShowDeleted()
public Books.Layers.VolumeAnnotations.List setShowDeleted(Boolean showDeleted)
public String getSource()
public Books.Layers.VolumeAnnotations.List setSource(String source)
public String getStartOffset()
public Books.Layers.VolumeAnnotations.List setStartOffset(String startOffset)
public String getStartPosition()
public Books.Layers.VolumeAnnotations.List setStartPosition(String startPosition)
public String getUpdatedMax()
public Books.Layers.VolumeAnnotations.List setUpdatedMax(String updatedMax)
public String getUpdatedMin()
public Books.Layers.VolumeAnnotations.List setUpdatedMin(String updatedMin)
public String getVolumeAnnotationsVersion()
public Books.Layers.VolumeAnnotations.List setVolumeAnnotationsVersion(String volumeAnnotationsVersion)
public Books.Layers.VolumeAnnotations.List set(String parameterName, Object value)
set in class BooksRequest<Volumeannotations>Copyright © 2011–2019 Google. All rights reserved.