gogol-streetviewpublish-0.4.0: Google Street View Publish 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.StreetViewPublish.Photos.BatchGet

Contents

Description

Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there was an authentication error. Even if BatchGetPhotos succeeds, there may have been failures for single photos in the batch. These failures will be specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.

See: Street View Publish API Reference for streetviewpublish.photos.batchGet.

Synopsis

REST Resource

type PhotosBatchGetResource = "v1" :> ("photos:batchGet" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "languageCode" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "photoIds" Text :> (QueryParam "view" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] BatchGetPhotosResponse)))))))))) Source #

A resource alias for streetviewpublish.photos.batchGet method which the PhotosBatchGet request conforms to.

Creating a Request

photosBatchGet :: PhotosBatchGet Source #

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

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

data PhotosBatchGet Source #

Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there was an authentication error. Even if BatchGetPhotos succeeds, there may have been failures for single photos in the batch. These failures will be specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.

See: photosBatchGet smart constructor.

Instances
Eq PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

Data PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

Methods

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

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

toConstr :: PhotosBatchGet -> Constr #

dataTypeOf :: PhotosBatchGet -> DataType #

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

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

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

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

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

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

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

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

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

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

Show PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

Generic PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

Associated Types

type Rep PhotosBatchGet :: Type -> Type #

GoogleRequest PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

Associated Types

type Rs PhotosBatchGet :: Type #

type Scopes PhotosBatchGet :: [Symbol] #

type Rep PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

type Rep PhotosBatchGet = D1 (MetaData "PhotosBatchGet" "Network.Google.Resource.StreetViewPublish.Photos.BatchGet" "gogol-streetviewpublish-0.4.0-hUlDUTRvH6EXX72hhSGUR" False) (C1 (MetaCons "PhotosBatchGet'" PrefixI True) (((S1 (MetaSel (Just "_pbgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_pbgLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pbgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pbgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pbgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pbgPhotoIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_pbgView") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pbgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

type Scopes PhotosBatchGet = "https://www.googleapis.com/auth/streetviewpublish" ': ([] :: [Symbol])
type Rs PhotosBatchGet Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photos.BatchGet

Request Lenses

pbgLanguageCode :: Lens' PhotosBatchGet (Maybe Text) Source #

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services will be used.

pbgUploadProtocol :: Lens' PhotosBatchGet (Maybe Text) Source #

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

pbgUploadType :: Lens' PhotosBatchGet (Maybe Text) Source #

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

pbgPhotoIds :: Lens' PhotosBatchGet [Text] Source #

Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`.

pbgView :: Lens' PhotosBatchGet (Maybe Text) Source #

Specifies if a download URL for the photo bytes should be returned in the Photo response.