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.Photo.StartUpload

Contents

Description

Creates an upload session to start uploading photo bytes. The upload URL of the returned UploadRef is used to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must also meet the following requirements: * Photo Sphere XMP metadata must be included in the photo medadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload is complete, the UploadRef is used with CreatePhoto to create the Photo object entry.

See: Street View Publish API Reference for streetviewpublish.photo.startUpload.

Synopsis

REST Resource

type PhotoStartUploadResource = "v1" :> ("photo:startUpload" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Empty :> Post '[JSON] UploadRef)))))))) Source #

A resource alias for streetviewpublish.photo.startUpload method which the PhotoStartUpload request conforms to.

Creating a Request

photoStartUpload Source #

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

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

data PhotoStartUpload Source #

Creates an upload session to start uploading photo bytes. The upload URL of the returned UploadRef is used to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must also meet the following requirements: * Photo Sphere XMP metadata must be included in the photo medadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload is complete, the UploadRef is used with CreatePhoto to create the Photo object entry.

See: photoStartUpload smart constructor.

Instances
Eq PhotoStartUpload Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

Data PhotoStartUpload Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

Methods

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

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

toConstr :: PhotoStartUpload -> Constr #

dataTypeOf :: PhotoStartUpload -> DataType #

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

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

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

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

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

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

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

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

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

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

Show PhotoStartUpload Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

Generic PhotoStartUpload Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

Associated Types

type Rep PhotoStartUpload :: Type -> Type #

GoogleRequest PhotoStartUpload Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

Associated Types

type Rs PhotoStartUpload :: Type #

type Scopes PhotoStartUpload :: [Symbol] #

type Rep PhotoStartUpload Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

type Rep PhotoStartUpload = D1 (MetaData "PhotoStartUpload" "Network.Google.Resource.StreetViewPublish.Photo.StartUpload" "gogol-streetviewpublish-0.4.0-hUlDUTRvH6EXX72hhSGUR" False) (C1 (MetaCons "PhotoStartUpload'" PrefixI True) ((S1 (MetaSel (Just "_psuXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_psuUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_psuAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_psuUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_psuPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Empty) :*: S1 (MetaSel (Just "_psuCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes PhotoStartUpload Source # 
Instance details

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

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

Defined in Network.Google.Resource.StreetViewPublish.Photo.StartUpload

Request Lenses

psuUploadProtocol :: Lens' PhotoStartUpload (Maybe Text) Source #

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

psuUploadType :: Lens' PhotoStartUpload (Maybe Text) Source #

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

psuPayload :: Lens' PhotoStartUpload Empty Source #

Multipart request metadata.