Network.Google.Resource.Books.Volumes.Get

Gets volume information for a single volume.

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

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))))))))))

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

Creating a Request

volumesGet

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:

• vgCountry
• vgIncludeNonComicsSeries
• vgPartner
• vgVolumeId
• vgSource
• vgProjection
• vgUserLibraryConsistentRead

data VolumesGet

Gets volume information for a single volume.

See: volumesGet smart constructor.

Instances

Eq VolumesGet

Methods

(==) :: VolumesGet -> VolumesGet -> Bool

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

Data VolumesGet

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

Methods

showsPrec :: Int -> VolumesGet -> ShowS

show :: VolumesGet -> String

showList :: [VolumesGet] -> ShowS

Generic VolumesGet

Associated Types

type Rep VolumesGet :: * -> *

Methods

from :: VolumesGet -> Rep VolumesGet x

to :: Rep VolumesGet x -> VolumesGet

GoogleRequest VolumesGet

Associated Types

type Rs VolumesGet :: *

type Scopes VolumesGet :: [Symbol]

Methods

requestClient :: VolumesGet -> Client (Rs VolumesGet)

type Rep VolumesGet

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

type Scopes VolumesGet

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

type Rs VolumesGet

type Rs VolumesGet = Volume

Request Lenses

vgCountry :: Lens' VolumesGet (Maybe Text)

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

vgIncludeNonComicsSeries :: Lens' VolumesGet (Maybe Bool)

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

vgPartner :: Lens' VolumesGet (Maybe Text)

Brand results for partner ID.

vgVolumeId :: Lens' VolumesGet Text

ID of volume to retrieve.

vgSource :: Lens' VolumesGet (Maybe Text)

String to identify the originator of this request.

vgProjection :: Lens' VolumesGet (Maybe VolumesGetProjection)

Restrict information returned to a set of selected fields.

vgUserLibraryConsistentRead :: Lens' VolumesGet (Maybe Bool)