Books.Layers.VolumeAnnotations.Get (Books API v1 (Rev. 114) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.books.BooksRequest<Volumeannotation>
        
        com.google.api.services.books.Books.Layers.VolumeAnnotations.Get

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Books.Layers.VolumeAnnotations
```
public class Books.Layers.VolumeAnnotations.Get
extends BooksRequest<Volumeannotation>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Get(java.lang.String volumeId, java.lang.String layerId, java.lang.String annotationId)
Gets the volume annotation.

Constructors
Modifier	Constructor and Description
`protected`	`Get(java.lang.String volumeId, java.lang.String layerId, java.lang.String annotationId)` Gets the volume annotation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getAnnotationId()` The ID of the volume annotation to retrieve.
`java.lang.String`	`getLayerId()` The ID for the layer to get the annotations.
`java.lang.String`	`getLocale()` The locale information for the data.
`java.lang.String`	`getSource()` String to identify the originator of this request.
`java.lang.String`	`getVolumeId()` The volume to retrieve annotations for.
`Books.Layers.VolumeAnnotations.Get`	`set(java.lang.String parameterName, java.lang.Object value)`
`Books.Layers.VolumeAnnotations.Get`	`setAlt(java.lang.String alt)` Data format for the response.
`Books.Layers.VolumeAnnotations.Get`	`setAnnotationId(java.lang.String annotationId)` The ID of the volume annotation to retrieve.
`Books.Layers.VolumeAnnotations.Get`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Books.Layers.VolumeAnnotations.Get`	`setKey(java.lang.String key)` API key.
`Books.Layers.VolumeAnnotations.Get`	`setLayerId(java.lang.String layerId)` The ID for the layer to get the annotations.
`Books.Layers.VolumeAnnotations.Get`	`setLocale(java.lang.String locale)` The locale information for the data.
`Books.Layers.VolumeAnnotations.Get`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Books.Layers.VolumeAnnotations.Get`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Books.Layers.VolumeAnnotations.Get`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Books.Layers.VolumeAnnotations.Get`	`setSource(java.lang.String source)` String to identify the originator of this request.
`Books.Layers.VolumeAnnotations.Get`	`setUserIp(java.lang.String userIp)` Deprecated.
`Books.Layers.VolumeAnnotations.Get`	`setVolumeId(java.lang.String volumeId)` The volume to retrieve annotations for.

Methods inherited from class com.google.api.services.books.BooksRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Get
```
protected Get(java.lang.String volumeId,
              java.lang.String layerId,
              java.lang.String annotationId)
```
    Gets the volume annotation. Create a request for the method "volumeAnnotations.get". This request holds the parameters needed by the the books server. After setting any optional parameters, call the 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.
    
    Parameters:
    
    volumeId - The volume to retrieve annotations for.
    
    layerId - The ID for the layer to get the annotations.
    
    annotationId - The ID of the volume annotation to retrieve.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Volumeannotation>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Volumeannotation>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Books.Layers.VolumeAnnotations.Get setAlt(java.lang.String alt)
```
    Description copied from class: BooksRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class BooksRequest<Volumeannotation>
  - setFields
```
public Books.Layers.VolumeAnnotations.Get setFields(java.lang.String fields)
```
    Description copied from class: BooksRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class BooksRequest<Volumeannotation>
  - setKey
```
public Books.Layers.VolumeAnnotations.Get setKey(java.lang.String key)
```
    Description copied from class: BooksRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class BooksRequest<Volumeannotation>
  - setOauthToken
```
public Books.Layers.VolumeAnnotations.Get setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: BooksRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class BooksRequest<Volumeannotation>
  - setPrettyPrint
```
public Books.Layers.VolumeAnnotations.Get setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: BooksRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class BooksRequest<Volumeannotation>
  - setQuotaUser
```
public Books.Layers.VolumeAnnotations.Get setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: BooksRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class BooksRequest<Volumeannotation>
  - setUserIp
```
public Books.Layers.VolumeAnnotations.Get setUserIp(java.lang.String userIp)
```
    Description copied from class: BooksRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class BooksRequest<Volumeannotation>
  - getVolumeId
```
public java.lang.String getVolumeId()
```
    The volume to retrieve annotations for.
  - setVolumeId
```
public Books.Layers.VolumeAnnotations.Get setVolumeId(java.lang.String volumeId)
```
    The volume to retrieve annotations for.
  - getLayerId
```
public java.lang.String getLayerId()
```
    The ID for the layer to get the annotations.
  - setLayerId
```
public Books.Layers.VolumeAnnotations.Get setLayerId(java.lang.String layerId)
```
    The ID for the layer to get the annotations.
  - getAnnotationId
```
public java.lang.String getAnnotationId()
```
    The ID of the volume annotation to retrieve.
  - setAnnotationId
```
public Books.Layers.VolumeAnnotations.Get setAnnotationId(java.lang.String annotationId)
```
    The ID of the volume annotation to retrieve.
  - getLocale
```
public java.lang.String getLocale()
```
    The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
  - setLocale
```
public Books.Layers.VolumeAnnotations.Get setLocale(java.lang.String locale)
```
    The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
  - getSource
```
public java.lang.String getSource()
```
    String to identify the originator of this request.
  - setSource
```
public Books.Layers.VolumeAnnotations.Get setSource(java.lang.String source)
```
    String to identify the originator of this request.
  - set
```
public Books.Layers.VolumeAnnotations.Get set(java.lang.String parameterName,
                                              java.lang.Object value)
```
    Overrides:
    
    set in class BooksRequest<Volumeannotation>

Books API v1 (revision 114)

Class Books.Layers.VolumeAnnotations.Get

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.books.BooksRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getVolumeId

setVolumeId

getLayerId

setLayerId

getAnnotationId

setAnnotationId

getLocale

setLocale

getSource

setSource

set