Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Books.Layers.VolumeAnnotations.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Gets the volume annotation.

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

Synopsis

type LayersVolumeAnnotationsGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> ("annotations" :> (Capture "annotationId" Text :> (QueryParam "locale" Text :> (QueryParam "source" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Volumeannotation))))))))))
layersVolumeAnnotationsGet :: Text -> Text -> Text -> LayersVolumeAnnotationsGet
data LayersVolumeAnnotationsGet
lvagLocale :: Lens' LayersVolumeAnnotationsGet (Maybe Text)
lvagAnnotationId :: Lens' LayersVolumeAnnotationsGet Text
lvagVolumeId :: Lens' LayersVolumeAnnotationsGet Text
lvagSource :: Lens' LayersVolumeAnnotationsGet (Maybe Text)
lvagLayerId :: Lens' LayersVolumeAnnotationsGet Text

REST Resource

type LayersVolumeAnnotationsGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> ("annotations" :> (Capture "annotationId" Text :> (QueryParam "locale" Text :> (QueryParam "source" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Volumeannotation)))))))))) Source #

A resource alias for books.layers.volumeAnnotations.get method which the LayersVolumeAnnotationsGet request conforms to.

Creating a Request

layersVolumeAnnotationsGet Source #

Arguments

:: Text	`lvagAnnotationId`
-> Text	`lvagVolumeId`
-> Text	`lvagLayerId`
-> LayersVolumeAnnotationsGet

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

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

data LayersVolumeAnnotationsGet Source #

Gets the volume annotation.

See: layersVolumeAnnotationsGet smart constructor.

Instances

Eq LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get Methods (==) :: LayersVolumeAnnotationsGet -> LayersVolumeAnnotationsGet -> Bool # (/=) :: LayersVolumeAnnotationsGet -> LayersVolumeAnnotationsGet -> Bool #
Data LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LayersVolumeAnnotationsGet -> c LayersVolumeAnnotationsGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LayersVolumeAnnotationsGet # toConstr :: LayersVolumeAnnotationsGet -> Constr # dataTypeOf :: LayersVolumeAnnotationsGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LayersVolumeAnnotationsGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LayersVolumeAnnotationsGet) # gmapT :: (forall b. Data b => b -> b) -> LayersVolumeAnnotationsGet -> LayersVolumeAnnotationsGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LayersVolumeAnnotationsGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LayersVolumeAnnotationsGet -> r # gmapQ :: (forall d. Data d => d -> u) -> LayersVolumeAnnotationsGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LayersVolumeAnnotationsGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LayersVolumeAnnotationsGet -> m LayersVolumeAnnotationsGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LayersVolumeAnnotationsGet -> m LayersVolumeAnnotationsGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LayersVolumeAnnotationsGet -> m LayersVolumeAnnotationsGet #
Show LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get Methods showsPrec :: Int -> LayersVolumeAnnotationsGet -> ShowS # show :: LayersVolumeAnnotationsGet -> String # showList :: [LayersVolumeAnnotationsGet] -> ShowS #
Generic LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get Associated Types type Rep LayersVolumeAnnotationsGet :: Type -> Type # Methods from :: LayersVolumeAnnotationsGet -> Rep LayersVolumeAnnotationsGet x # to :: Rep LayersVolumeAnnotationsGet x -> LayersVolumeAnnotationsGet #
GoogleRequest LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get Associated Types type Rs LayersVolumeAnnotationsGet :: Type # type Scopes LayersVolumeAnnotationsGet :: [Symbol] # Methods requestClient :: LayersVolumeAnnotationsGet -> GClient (Rs LayersVolumeAnnotationsGet) #
type Rep LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get type Rep LayersVolumeAnnotationsGet = D1 (MetaData "LayersVolumeAnnotationsGet" "Network.Google.Resource.Books.Layers.VolumeAnnotations.Get" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "LayersVolumeAnnotationsGet'" PrefixI True) ((S1 (MetaSel (Just "_lvagLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lvagAnnotationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_lvagVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_lvagSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lvagLayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Scopes LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get type Scopes LayersVolumeAnnotationsGet = "https://www.googleapis.com/auth/books" ': ([] :: [Symbol])
type Rs LayersVolumeAnnotationsGet Source #
Instance details Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.Get type Rs LayersVolumeAnnotationsGet = Volumeannotation

Request Lenses

lvagLocale :: Lens' LayersVolumeAnnotationsGet (Maybe Text) Source #

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

lvagAnnotationId :: Lens' LayersVolumeAnnotationsGet Text Source #

The ID of the volume annotation to retrieve.

lvagVolumeId :: Lens' LayersVolumeAnnotationsGet Text Source #

The volume to retrieve annotations for.

lvagSource :: Lens' LayersVolumeAnnotationsGet (Maybe Text) Source #

String to identify the originator of this request.

lvagLayerId :: Lens' LayersVolumeAnnotationsGet Text Source #

The ID for the layer to get the annotations.