gogol-books-0.4.0: Google Books SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Books.Volumes.Get

Contents

Description

Gets volume information for a single volume.

See: Books API Reference for books.volumes.get.

Synopsis

REST Resource

type VolumesGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> (QueryParam "country" Text :> (QueryParam "includeNonComicsSeries" Bool :> (QueryParam "partner" Text :> (QueryParam "source" Text :> (QueryParam "projection" VolumesGetProjection :> (QueryParam "user_library_consistent_read" Bool :> (QueryParam "alt" AltJSON :> Get '[JSON] Volume)))))))))) Source #

A resource alias for books.volumes.get method which the VolumesGet request conforms to.

Creating a Request

volumesGet Source #

Arguments

:: Text

vgVolumeId

-> VolumesGet 

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

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

data VolumesGet Source #

Gets volume information for a single volume.

See: volumesGet smart constructor.

Instances
Eq VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

Data VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

Methods

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

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

toConstr :: VolumesGet -> Constr #

dataTypeOf :: VolumesGet -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> VolumesGet -> VolumesGet #

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

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

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

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

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

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

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

Show VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

Generic VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

Associated Types

type Rep VolumesGet :: Type -> Type #

GoogleRequest VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

Associated Types

type Rs VolumesGet :: Type #

type Scopes VolumesGet :: [Symbol] #

type Rep VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

type Rep VolumesGet = D1 (MetaData "VolumesGet" "Network.Google.Resource.Books.Volumes.Get" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "VolumesGet'" PrefixI True) ((S1 (MetaSel (Just "_vgCountry") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_vgIncludeNonComicsSeries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_vgPartner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_vgVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_vgSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_vgProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesGetProjection)) :*: S1 (MetaSel (Just "_vgUserLibraryConsistentRead") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))
type Scopes VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

type Scopes VolumesGet = "https://www.googleapis.com/auth/books" ': ([] :: [Symbol])
type Rs VolumesGet Source # 
Instance details

Defined in Network.Google.Resource.Books.Volumes.Get

Request Lenses

vgCountry :: Lens' VolumesGet (Maybe Text) Source #

ISO-3166-1 code to override the IP-based location.

vgIncludeNonComicsSeries :: Lens' VolumesGet (Maybe Bool) Source #

Set to true to include non-comics series. Defaults to false.

vgPartner :: Lens' VolumesGet (Maybe Text) Source #

Brand results for partner ID.

vgVolumeId :: Lens' VolumesGet Text Source #

ID of volume to retrieve.

vgSource :: Lens' VolumesGet (Maybe Text) Source #

String to identify the originator of this request.

vgProjection :: Lens' VolumesGet (Maybe VolumesGetProjection) Source #

Restrict information returned to a set of selected fields.