Network.Google.Resource.Books.Layers.AnnotationData.Get

Gets the annotation data.

See: Books API Reference for books.layers.annotationData.get.

REST Resource

type LayersAnnotationDataGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> ("data" :> (Capture "annotationDataId" Text :> (QueryParam "contentVersion" Text :> (QueryParam "w" (Textual Int32) :> (QueryParam "scale" (Textual Int32) :> (QueryParam "locale" Text :> (QueryParam "allowWebDefinitions" Bool :> (QueryParam "source" Text :> (QueryParam "h" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AnnotationData)))))))))))))))

A resource alias for books.layers.annotationData.get method which the LayersAnnotationDataGet request conforms to.

Creating a Request

layersAnnotationDataGet

Arguments

:: Text

ladgContentVersion

-> Text

ladgAnnotationDataId

-> Text

ladgVolumeId

-> Text

ladgLayerId

-> LayersAnnotationDataGet

Creates a value of LayersAnnotationDataGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ladgW
• ladgScale
• ladgLocale
• ladgContentVersion
• ladgAllowWebDefinitions
• ladgAnnotationDataId
• ladgVolumeId
• ladgSource
• ladgH
• ladgLayerId

data LayersAnnotationDataGet

Gets the annotation data.

See: layersAnnotationDataGet smart constructor.

Instances

Eq LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

Methods

(==) :: LayersAnnotationDataGet -> LayersAnnotationDataGet -> Bool

(/=) :: LayersAnnotationDataGet -> LayersAnnotationDataGet -> Bool

Data LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LayersAnnotationDataGet -> c LayersAnnotationDataGet

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LayersAnnotationDataGet

toConstr :: LayersAnnotationDataGet -> Constr

dataTypeOf :: LayersAnnotationDataGet -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LayersAnnotationDataGet)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LayersAnnotationDataGet)

gmapT :: (forall b. Data b => b -> b) -> LayersAnnotationDataGet -> LayersAnnotationDataGet

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LayersAnnotationDataGet -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LayersAnnotationDataGet -> r

gmapQ :: (forall d. Data d => d -> u) -> LayersAnnotationDataGet -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> LayersAnnotationDataGet -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LayersAnnotationDataGet -> m LayersAnnotationDataGet

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LayersAnnotationDataGet -> m LayersAnnotationDataGet

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LayersAnnotationDataGet -> m LayersAnnotationDataGet

Show LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

Methods

showsPrec :: Int -> LayersAnnotationDataGet -> ShowS

show :: LayersAnnotationDataGet -> String

showList :: [LayersAnnotationDataGet] -> ShowS

Generic LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

Associated Types

type Rep LayersAnnotationDataGet :: Type -> Type

Methods

from :: LayersAnnotationDataGet -> Rep LayersAnnotationDataGet x

to :: Rep LayersAnnotationDataGet x -> LayersAnnotationDataGet

GoogleRequest LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

Associated Types

type Rs LayersAnnotationDataGet :: Type

type Scopes LayersAnnotationDataGet :: [Symbol]

Methods

requestClient :: LayersAnnotationDataGet -> GClient (Rs LayersAnnotationDataGet)

type Rep LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

type Rep LayersAnnotationDataGet = D1 (MetaData "LayersAnnotationDataGet" "Network.Google.Resource.Books.Layers.AnnotationData.Get" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "LayersAnnotationDataGet'" PrefixI True) (((S1 (MetaSel (Just "_ladgW") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_ladgScale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :*: (S1 (MetaSel (Just "_ladgLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ladgContentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ladgAllowWebDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 (MetaSel (Just "_ladgAnnotationDataId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ladgVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_ladgSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ladgH") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_ladgLayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Scopes LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

type Scopes LayersAnnotationDataGet = "https://www.googleapis.com/auth/books" ': ([] :: [Symbol])

type Rs LayersAnnotationDataGet

Defined in Network.Google.Resource.Books.Layers.AnnotationData.Get

type Rs LayersAnnotationDataGet = AnnotationData

Request Lenses

ladgW :: Lens' LayersAnnotationDataGet (Maybe Int32)

The requested pixel width for any images. If width is provided height must also be provided.

ladgScale :: Lens' LayersAnnotationDataGet (Maybe Int32)

The requested scale for the image.

ladgLocale :: Lens' LayersAnnotationDataGet (Maybe Text)

The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

ladgContentVersion :: Lens' LayersAnnotationDataGet Text

The content version for the volume you are trying to retrieve.

ladgAllowWebDefinitions :: Lens' LayersAnnotationDataGet (Maybe Bool)

For the dictionary layer. Whether or not to allow web definitions.

ladgAnnotationDataId :: Lens' LayersAnnotationDataGet Text

The ID of the annotation data to retrieve.

ladgVolumeId :: Lens' LayersAnnotationDataGet Text

The volume to retrieve annotations for.

ladgSource :: Lens' LayersAnnotationDataGet (Maybe Text)

String to identify the originator of this request.

ladgH :: Lens' LayersAnnotationDataGet (Maybe Int32)

The requested pixel height for any images. If height is provided width must also be provided.

ladgLayerId :: Lens' LayersAnnotationDataGet Text

The ID for the layer to get the annotations.