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.Webmasters.Sitemaps.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

See: Search Console API Reference for webmasters.sitemaps.list.

Synopsis

type SitemapsListResource = "webmasters" :> ("v3" :> ("sites" :> (Capture "siteUrl" Text :> ("sitemaps" :> (QueryParam "sitemapIndex" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] SitemapsListResponse))))))
sitemapsList :: Text -> SitemapsList
data SitemapsList
slSiteURL :: Lens' SitemapsList Text
slSitemapIndex :: Lens' SitemapsList (Maybe Text)

REST Resource

type SitemapsListResource = "webmasters" :> ("v3" :> ("sites" :> (Capture "siteUrl" Text :> ("sitemaps" :> (QueryParam "sitemapIndex" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] SitemapsListResponse)))))) Source #

A resource alias for webmasters.sitemaps.list method which the SitemapsList request conforms to.

Creating a Request

sitemapsList Source #

Arguments

:: Text	`slSiteURL`
-> SitemapsList

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

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

slSiteURL
slSitemapIndex

data SitemapsList Source #

Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

See: sitemapsList smart constructor.

Instances

Eq SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List Methods (==) :: SitemapsList -> SitemapsList -> Bool # (/=) :: SitemapsList -> SitemapsList -> Bool #
Data SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SitemapsList -> c SitemapsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SitemapsList # toConstr :: SitemapsList -> Constr # dataTypeOf :: SitemapsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SitemapsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SitemapsList) # gmapT :: (forall b. Data b => b -> b) -> SitemapsList -> SitemapsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SitemapsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SitemapsList -> r # gmapQ :: (forall d. Data d => d -> u) -> SitemapsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SitemapsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SitemapsList -> m SitemapsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SitemapsList -> m SitemapsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SitemapsList -> m SitemapsList #
Show SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List Methods showsPrec :: Int -> SitemapsList -> ShowS # show :: SitemapsList -> String # showList :: [SitemapsList] -> ShowS #
Generic SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List Associated Types type Rep SitemapsList :: Type -> Type # Methods from :: SitemapsList -> Rep SitemapsList x # to :: Rep SitemapsList x -> SitemapsList #
GoogleRequest SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List Associated Types type Rs SitemapsList :: Type # type Scopes SitemapsList :: [Symbol] # Methods requestClient :: SitemapsList -> GClient (Rs SitemapsList) #
type Rep SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List type Rep SitemapsList = D1 (MetaData "SitemapsList" "Network.Google.Resource.Webmasters.Sitemaps.List" "gogol-webmaster-tools-0.4.0-LKq04HhuGk13qpGnIbIn8X" False) (C1 (MetaCons "SitemapsList'" PrefixI True) (S1 (MetaSel (Just "_slSiteURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_slSitemapIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))
type Scopes SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List type Scopes SitemapsList = "https://www.googleapis.com/auth/webmasters" ': ("https://www.googleapis.com/auth/webmasters.readonly" ': ([] :: [Symbol]))
type Rs SitemapsList Source #
Instance details Defined in Network.Google.Resource.Webmasters.Sitemaps.List type Rs SitemapsList = SitemapsListResponse

Request Lenses

slSiteURL :: Lens' SitemapsList Text Source #

The site's URL, including protocol. For example: http://www.example.com/

slSitemapIndex :: Lens' SitemapsList (Maybe Text) Source #

A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml