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.LibraryAgent.Shelves.Books.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

See: Library Agent API Reference for libraryagent.shelves.books.list.

Synopsis

type ShelvesBooksListResource = "v1" :> (Capture "parent" Text :> ("books" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleExampleLibraryagentV1ListBooksResponse))))))))))
shelvesBooksList :: Text -> ShelvesBooksList
data ShelvesBooksList
sblParent :: Lens' ShelvesBooksList Text
sblXgafv :: Lens' ShelvesBooksList (Maybe Xgafv)
sblUploadProtocol :: Lens' ShelvesBooksList (Maybe Text)
sblAccessToken :: Lens' ShelvesBooksList (Maybe Text)
sblUploadType :: Lens' ShelvesBooksList (Maybe Text)
sblPageToken :: Lens' ShelvesBooksList (Maybe Text)
sblPageSize :: Lens' ShelvesBooksList (Maybe Int32)
sblCallback :: Lens' ShelvesBooksList (Maybe Text)

REST Resource

type ShelvesBooksListResource = "v1" :> (Capture "parent" Text :> ("books" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleExampleLibraryagentV1ListBooksResponse)))))))))) Source #

A resource alias for libraryagent.shelves.books.list method which the ShelvesBooksList request conforms to.

Creating a Request

shelvesBooksList Source #

Arguments

:: Text	`sblParent`
-> ShelvesBooksList

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

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

data ShelvesBooksList Source #

Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

See: shelvesBooksList smart constructor.

Instances

Eq ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List Methods (==) :: ShelvesBooksList -> ShelvesBooksList -> Bool # (/=) :: ShelvesBooksList -> ShelvesBooksList -> Bool #
Data ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ShelvesBooksList -> c ShelvesBooksList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ShelvesBooksList # toConstr :: ShelvesBooksList -> Constr # dataTypeOf :: ShelvesBooksList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ShelvesBooksList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ShelvesBooksList) # gmapT :: (forall b. Data b => b -> b) -> ShelvesBooksList -> ShelvesBooksList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ShelvesBooksList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ShelvesBooksList -> r # gmapQ :: (forall d. Data d => d -> u) -> ShelvesBooksList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ShelvesBooksList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ShelvesBooksList -> m ShelvesBooksList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ShelvesBooksList -> m ShelvesBooksList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ShelvesBooksList -> m ShelvesBooksList #
Show ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List Methods showsPrec :: Int -> ShelvesBooksList -> ShowS # show :: ShelvesBooksList -> String # showList :: [ShelvesBooksList] -> ShowS #
Generic ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List Associated Types type Rep ShelvesBooksList :: Type -> Type # Methods from :: ShelvesBooksList -> Rep ShelvesBooksList x # to :: Rep ShelvesBooksList x -> ShelvesBooksList #
GoogleRequest ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List Associated Types type Rs ShelvesBooksList :: Type # type Scopes ShelvesBooksList :: [Symbol] # Methods requestClient :: ShelvesBooksList -> GClient (Rs ShelvesBooksList) #
type Rep ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List type Rep ShelvesBooksList = D1 (MetaData "ShelvesBooksList" "Network.Google.Resource.LibraryAgent.Shelves.Books.List" "gogol-libraryagent-0.4.0-3DDw7qDFYgp6HuQ2dTY0m5" False) (C1 (MetaCons "ShelvesBooksList'" PrefixI True) (((S1 (MetaSel (Just "_sblParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_sblXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :: (S1 (MetaSel (Just "_sblUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sblAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_sblUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sblPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_sblPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sblCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List type Scopes ShelvesBooksList = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ShelvesBooksList Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.List type Rs ShelvesBooksList = GoogleExampleLibraryagentV1ListBooksResponse

Request Lenses

sblParent :: Lens' ShelvesBooksList Text Source #

The name of the shelf whose books we'd like to list.

sblXgafv :: Lens' ShelvesBooksList (Maybe Xgafv) Source #

V1 error format.

sblUploadProtocol :: Lens' ShelvesBooksList (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

sblAccessToken :: Lens' ShelvesBooksList (Maybe Text) Source #

OAuth access token.

sblUploadType :: Lens' ShelvesBooksList (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

sblPageToken :: Lens' ShelvesBooksList (Maybe Text) Source #

A token identifying a page of results the server should return. Typically, this is the value of ListBooksResponse.next_page_token. returned from the previous call to `ListBooks` method.

sblPageSize :: Lens' ShelvesBooksList (Maybe Int32) Source #

Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.

sblCallback :: Lens' ShelvesBooksList (Maybe Text) Source #

JSONP