gogol-maps-engine-0.3.0: Google Maps Engine SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.MapsEngine.Maps.List

Contents

Description

Return all maps readable by the current user.

See: Google Maps Engine API Reference for mapsengine.maps.list.

Synopsis

REST Resource

type MapsListResource = "mapsengine" :> ("v1" :> ("maps" :> (QueryParam "createdAfter" DateTime' :> (QueryParam "creatorEmail" Text :> (QueryParam "role" MapsListRole :> (QueryParam "bbox" Text :> (QueryParam "processingStatus" MapsListProcessingStatus :> (QueryParam "modifiedAfter" DateTime' :> (QueryParam "modifiedBefore" DateTime' :> (QueryParam "pageToken" Text :> (QueryParam "projectId" Text :> (QueryParam "search" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "tags" Text :> (QueryParam "createdBefore" DateTime' :> (QueryParam "alt" AltJSON :> Get '[JSON] MapsListResponse)))))))))))))))) Source #

A resource alias for mapsengine.maps.list method which the MapsList request conforms to.

Creating a Request

mapsList :: MapsList Source #

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

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

data MapsList Source #

Return all maps readable by the current user.

See: mapsList smart constructor.

Instances

Eq MapsList Source # 
Data MapsList Source # 

Methods

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

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

toConstr :: MapsList -> Constr #

dataTypeOf :: MapsList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MapsList) #

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

gmapT :: (forall b. Data b => b -> b) -> MapsList -> MapsList #

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

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

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

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

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

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

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

Show MapsList Source # 
Generic MapsList Source # 

Associated Types

type Rep MapsList :: * -> * #

Methods

from :: MapsList -> Rep MapsList x #

to :: Rep MapsList x -> MapsList #

GoogleRequest MapsList Source # 

Associated Types

type Rs MapsList :: * #

type Scopes MapsList :: [Symbol] #

type Rep MapsList Source # 
type Rep MapsList = D1 (MetaData "MapsList" "Network.Google.Resource.MapsEngine.Maps.List" "gogol-maps-engine-0.3.0-8urOfAmB6laBICTI61kKED" False) (C1 (MetaCons "MapsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mlCreatedAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))) ((:*:) (S1 (MetaSel (Just Symbol "_mlCreatorEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mlRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MapsListRole))))) ((:*:) (S1 (MetaSel (Just Symbol "_mlBbox") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_mlProcessingStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MapsListProcessingStatus))) (S1 (MetaSel (Just Symbol "_mlModifiedAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mlModifiedBefore") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))) ((:*:) (S1 (MetaSel (Just Symbol "_mlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mlProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mlSearch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))))) ((:*:) (S1 (MetaSel (Just Symbol "_mlTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mlCreatedBefore") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))))))))
type Scopes MapsList Source # 
type Scopes MapsList = (:) Symbol "https://www.googleapis.com/auth/mapsengine" ((:) Symbol "https://www.googleapis.com/auth/mapsengine.readonly" ([] Symbol))
type Rs MapsList Source # 

Request Lenses

mlCreatedAfter :: Lens' MapsList (Maybe UTCTime) Source #

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.

mlCreatorEmail :: Lens' MapsList (Maybe Text) Source #

An email address representing a user. Returned assets that have been created by the user associated with the provided email address.

mlRole :: Lens' MapsList (Maybe MapsListRole) Source #

The role parameter indicates that the response should only contain assets where the current user has the specified level of access.

mlBbox :: Lens' MapsList (Maybe Text) Source #

A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.

mlModifiedAfter :: Lens' MapsList (Maybe UTCTime) Source #

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.

mlModifiedBefore :: Lens' MapsList (Maybe UTCTime) Source #

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.

mlPageToken :: Lens' MapsList (Maybe Text) Source #

The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

mlProjectId :: Lens' MapsList (Maybe Text) Source #

The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.

mlSearch :: Lens' MapsList (Maybe Text) Source #

An unstructured search string used to filter the set of results based on asset metadata.

mlMaxResults :: Lens' MapsList (Maybe Word32) Source #

The maximum number of items to include in a single response page. The maximum supported value is 100.

mlTags :: Lens' MapsList (Maybe Text) Source #

A comma separated list of tags. Returned assets will contain all the tags from the list.

mlCreatedBefore :: Lens' MapsList (Maybe UTCTime) Source #

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.