Network.Google.Resource.Books.Layers.AnnotationData.List

Gets the annotation data for a volume and layer.

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

REST Resource

type LayersAnnotationDataListResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> ("data" :> (QueryParam "contentVersion" Text :> (QueryParam "w" (Textual Int32) :> (QueryParam "scale" (Textual Int32) :> (QueryParam "locale" Text :> (QueryParam "updatedMax" Text :> (QueryParam "updatedMin" Text :> (QueryParams "annotationDataId" Text :> (QueryParam "source" Text :> (QueryParam "h" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AnnotationsData))))))))))))))))))

A resource alias for books.layers.annotationData.list method which the LayersAnnotationDataList request conforms to.

Creating a Request

layersAnnotationDataList

Arguments

:: Text

ladlContentVersion

-> Text

ladlVolumeId

-> Text

ladlLayerId

-> LayersAnnotationDataList

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

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

• ladlW
• ladlScale
• ladlLocale
• ladlContentVersion
• ladlUpdatedMax
• ladlUpdatedMin
• ladlAnnotationDataId
• ladlVolumeId
• ladlSource
• ladlH
• ladlPageToken
• ladlLayerId
• ladlMaxResults

data LayersAnnotationDataList

Gets the annotation data for a volume and layer.

See: layersAnnotationDataList smart constructor.

Instances

Eq LayersAnnotationDataList

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

Methods

(==) :: LayersAnnotationDataList -> LayersAnnotationDataList -> Bool

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

Data LayersAnnotationDataList

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

Methods

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

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

toConstr :: LayersAnnotationDataList -> Constr

dataTypeOf :: LayersAnnotationDataList -> DataType

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

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

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

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

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

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

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

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

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

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

Show LayersAnnotationDataList

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

Methods

showsPrec :: Int -> LayersAnnotationDataList -> ShowS

show :: LayersAnnotationDataList -> String

showList :: [LayersAnnotationDataList] -> ShowS

Generic LayersAnnotationDataList

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

Associated Types

type Rep LayersAnnotationDataList :: Type -> Type

Methods

from :: LayersAnnotationDataList -> Rep LayersAnnotationDataList x

to :: Rep LayersAnnotationDataList x -> LayersAnnotationDataList

GoogleRequest LayersAnnotationDataList

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

Associated Types

type Rs LayersAnnotationDataList :: Type

type Scopes LayersAnnotationDataList :: [Symbol]

Methods

requestClient :: LayersAnnotationDataList -> GClient (Rs LayersAnnotationDataList)

type Rep LayersAnnotationDataList

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

type Rep LayersAnnotationDataList = D1 (MetaData "LayersAnnotationDataList" "Network.Google.Resource.Books.Layers.AnnotationData.List" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "LayersAnnotationDataList'" PrefixI True) (((S1 (MetaSel (Just "_ladlW") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_ladlScale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_ladlLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_ladlContentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_ladlUpdatedMax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ladlUpdatedMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_ladlAnnotationDataId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_ladlVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ladlSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_ladlH") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_ladlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ladlLayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ladlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))))))))

type Scopes LayersAnnotationDataList

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

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

type Rs LayersAnnotationDataList

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

type Rs LayersAnnotationDataList = AnnotationsData

Request Lenses

ladlW :: Lens' LayersAnnotationDataList (Maybe Int32)

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

ladlScale :: Lens' LayersAnnotationDataList (Maybe Int32)

The requested scale for the image.

ladlLocale :: Lens' LayersAnnotationDataList (Maybe Text)

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

ladlContentVersion :: Lens' LayersAnnotationDataList Text

The content version for the requested volume.

ladlUpdatedMax :: Lens' LayersAnnotationDataList (Maybe Text)

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

ladlUpdatedMin :: Lens' LayersAnnotationDataList (Maybe Text)

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

ladlAnnotationDataId :: Lens' LayersAnnotationDataList [Text]

The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.

ladlVolumeId :: Lens' LayersAnnotationDataList Text

The volume to retrieve annotation data for.

ladlSource :: Lens' LayersAnnotationDataList (Maybe Text)

String to identify the originator of this request.

ladlH :: Lens' LayersAnnotationDataList (Maybe Int32)

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

ladlPageToken :: Lens' LayersAnnotationDataList (Maybe Text)

The value of the nextToken from the previous page.

ladlLayerId :: Lens' LayersAnnotationDataList Text

The ID for the layer to get the annotation data.

ladlMaxResults :: Lens' LayersAnnotationDataList (Maybe Word32)

Maximum number of results to return