Network.Google.Resource.Books.Layers.VolumeAnnotations.List

Gets the volume annotations for a volume and layer.

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

REST Resource

type LayersVolumeAnnotationsListResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> (QueryParam "contentVersion" Text :> (QueryParam "startOffset" Text :> (QueryParam "locale" Text :> (QueryParam "showDeleted" Bool :> (QueryParam "volumeAnnotationsVersion" Text :> (QueryParam "updatedMax" Text :> (QueryParam "updatedMin" Text :> (QueryParam "endOffset" Text :> (QueryParam "source" Text :> (QueryParam "pageToken" Text :> (QueryParam "endPosition" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "startPosition" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Volumeannotations)))))))))))))))))))

A resource alias for books.layers.volumeAnnotations.list method which the LayersVolumeAnnotationsList request conforms to.

Creating a Request

layersVolumeAnnotationsList

Arguments

:: Text

lvalContentVersion

-> Text

lvalVolumeId

-> Text

lvalLayerId

-> LayersVolumeAnnotationsList

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

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

• lvalStartOffSet
• lvalLocale
• lvalContentVersion
• lvalShowDeleted
• lvalVolumeAnnotationsVersion
• lvalUpdatedMax
• lvalUpdatedMin
• lvalEndOffSet
• lvalVolumeId
• lvalSource
• lvalPageToken
• lvalEndPosition
• lvalLayerId
• lvalMaxResults
• lvalStartPosition

data LayersVolumeAnnotationsList

Gets the volume annotations for a volume and layer.

See: layersVolumeAnnotationsList smart constructor.

Instances

Eq LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

Methods

(==) :: LayersVolumeAnnotationsList -> LayersVolumeAnnotationsList -> Bool

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

Data LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

Methods

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

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

toConstr :: LayersVolumeAnnotationsList -> Constr

dataTypeOf :: LayersVolumeAnnotationsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

Methods

showsPrec :: Int -> LayersVolumeAnnotationsList -> ShowS

show :: LayersVolumeAnnotationsList -> String

showList :: [LayersVolumeAnnotationsList] -> ShowS

Generic LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

Associated Types

type Rep LayersVolumeAnnotationsList :: Type -> Type

Methods

from :: LayersVolumeAnnotationsList -> Rep LayersVolumeAnnotationsList x

to :: Rep LayersVolumeAnnotationsList x -> LayersVolumeAnnotationsList

GoogleRequest LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

Associated Types

type Rs LayersVolumeAnnotationsList :: Type

type Scopes LayersVolumeAnnotationsList :: [Symbol]

Methods

requestClient :: LayersVolumeAnnotationsList -> GClient (Rs LayersVolumeAnnotationsList)

type Rep LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

type Rep LayersVolumeAnnotationsList = D1 (MetaData "LayersVolumeAnnotationsList" "Network.Google.Resource.Books.Layers.VolumeAnnotations.List" "gogol-books-0.5.0-5eGHzODss8vLDz8eryP3W5" False) (C1 (MetaCons "LayersVolumeAnnotationsList'" PrefixI True) (((S1 (MetaSel (Just "_lvalStartOffSet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lvalLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lvalContentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_lvalShowDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_lvalVolumeAnnotationsVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lvalUpdatedMax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lvalUpdatedMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_lvalEndOffSet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lvalVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_lvalSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lvalPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_lvalEndPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lvalLayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_lvalMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: S1 (MetaSel (Just "_lvalStartPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

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

type Rs LayersVolumeAnnotationsList

Defined in Network.Google.Resource.Books.Layers.VolumeAnnotations.List

type Rs LayersVolumeAnnotationsList = Volumeannotations

Request Lenses

lvalStartOffSet :: Lens' LayersVolumeAnnotationsList (Maybe Text)

The start offset to start retrieving data from.

lvalLocale :: Lens' LayersVolumeAnnotationsList (Maybe Text)

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

lvalContentVersion :: Lens' LayersVolumeAnnotationsList Text

The content version for the requested volume.

lvalShowDeleted :: Lens' LayersVolumeAnnotationsList (Maybe Bool)

Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

lvalVolumeAnnotationsVersion :: Lens' LayersVolumeAnnotationsList (Maybe Text)

The version of the volume annotations that you are requesting.

lvalUpdatedMax :: Lens' LayersVolumeAnnotationsList (Maybe Text)

RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

lvalUpdatedMin :: Lens' LayersVolumeAnnotationsList (Maybe Text)

RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

lvalEndOffSet :: Lens' LayersVolumeAnnotationsList (Maybe Text)

The end offset to end retrieving data from.

lvalVolumeId :: Lens' LayersVolumeAnnotationsList Text

The volume to retrieve annotations for.

lvalSource :: Lens' LayersVolumeAnnotationsList (Maybe Text)

String to identify the originator of this request.

lvalPageToken :: Lens' LayersVolumeAnnotationsList (Maybe Text)

The value of the nextToken from the previous page.

lvalEndPosition :: Lens' LayersVolumeAnnotationsList (Maybe Text)

The end position to end retrieving data from.

lvalLayerId :: Lens' LayersVolumeAnnotationsList Text

The ID for the layer to get the annotations.

lvalMaxResults :: Lens' LayersVolumeAnnotationsList (Maybe Word32)

Maximum number of results to return

lvalStartPosition :: Lens' LayersVolumeAnnotationsList (Maybe Text)

The start position to start retrieving data from.