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.StreetViewPublish.Photo.Update

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates the metadata of a Photo, such as pose, place association, connections, etc. Changing the pixels of a photo is not supported. Only the fields specified in the updateMask field are used. If `updateMask` is not present, the update applies to all fields. Note: To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * google.rpc.Code.NOT_FOUND if the requested photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.

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

Synopsis

type PhotoUpdateResource = "v1" :> ("photo" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Photo :> Put '[JSON] Photo))))))))))
photoUpdate :: Photo -> Text -> PhotoUpdate
data PhotoUpdate
puXgafv :: Lens' PhotoUpdate (Maybe Xgafv)
puUploadProtocol :: Lens' PhotoUpdate (Maybe Text)
puUpdateMask :: Lens' PhotoUpdate (Maybe GFieldMask)
puAccessToken :: Lens' PhotoUpdate (Maybe Text)
puUploadType :: Lens' PhotoUpdate (Maybe Text)
puPayload :: Lens' PhotoUpdate Photo
puId :: Lens' PhotoUpdate Text
puCallback :: Lens' PhotoUpdate (Maybe Text)

REST Resource

type PhotoUpdateResource = "v1" :> ("photo" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Photo :> Put '[JSON] Photo)))))))))) Source #

A resource alias for streetviewpublish.photo.update method which the PhotoUpdate request conforms to.

Creating a Request

photoUpdate Source #

Arguments

:: Photo	`puPayload`
-> Text	`puId`
-> PhotoUpdate

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

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

data PhotoUpdate Source #

Updates the metadata of a Photo, such as pose, place association, connections, etc. Changing the pixels of a photo is not supported. Only the fields specified in the updateMask field are used. If `updateMask` is not present, the update applies to all fields. Note: To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * google.rpc.Code.NOT_FOUND if the requested photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.

See: photoUpdate smart constructor.

Instances

Eq PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update Methods (==) :: PhotoUpdate -> PhotoUpdate -> Bool # (/=) :: PhotoUpdate -> PhotoUpdate -> Bool #
Data PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PhotoUpdate -> c PhotoUpdate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PhotoUpdate # toConstr :: PhotoUpdate -> Constr # dataTypeOf :: PhotoUpdate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PhotoUpdate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PhotoUpdate) # gmapT :: (forall b. Data b => b -> b) -> PhotoUpdate -> PhotoUpdate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PhotoUpdate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PhotoUpdate -> r # gmapQ :: (forall d. Data d => d -> u) -> PhotoUpdate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PhotoUpdate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PhotoUpdate -> m PhotoUpdate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PhotoUpdate -> m PhotoUpdate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PhotoUpdate -> m PhotoUpdate #
Show PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update Methods showsPrec :: Int -> PhotoUpdate -> ShowS # show :: PhotoUpdate -> String # showList :: [PhotoUpdate] -> ShowS #
Generic PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update Associated Types type Rep PhotoUpdate :: Type -> Type # Methods from :: PhotoUpdate -> Rep PhotoUpdate x # to :: Rep PhotoUpdate x -> PhotoUpdate #
GoogleRequest PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update Associated Types type Rs PhotoUpdate :: Type # type Scopes PhotoUpdate :: [Symbol] # Methods requestClient :: PhotoUpdate -> GClient (Rs PhotoUpdate) #
type Rep PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update type Rep PhotoUpdate = D1 (MetaData "PhotoUpdate" "Network.Google.Resource.StreetViewPublish.Photo.Update" "gogol-streetviewpublish-0.4.0-hUlDUTRvH6EXX72hhSGUR" False) (C1 (MetaCons "PhotoUpdate'" PrefixI True) (((S1 (MetaSel (Just "_puXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_puUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_puUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :: S1 (MetaSel (Just "_puAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_puUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_puPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Photo)) :: (S1 (MetaSel (Just "_puId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_puCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update type Scopes PhotoUpdate = "https://www.googleapis.com/auth/streetviewpublish" ': ([] :: [Symbol])
type Rs PhotoUpdate Source #
Instance details Defined in Network.Google.Resource.StreetViewPublish.Photo.Update type Rs PhotoUpdate = Photo

Request Lenses

puXgafv :: Lens' PhotoUpdate (Maybe Xgafv) Source #

V1 error format.

puUploadProtocol :: Lens' PhotoUpdate (Maybe Text) Source #

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

puUpdateMask :: Lens' PhotoUpdate (Maybe GFieldMask) Source #

Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata will be entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` Note: Repeated fields in updateMask mean the entire set of repeated values will be replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections will be removed.

puAccessToken :: Lens' PhotoUpdate (Maybe Text) Source #

OAuth access token.

puUploadType :: Lens' PhotoUpdate (Maybe Text) Source #

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

puPayload :: Lens' PhotoUpdate Photo Source #

Multipart request metadata.

puId :: Lens' PhotoUpdate Text Source #

Required. A unique identifier for a photo.

puCallback :: Lens' PhotoUpdate (Maybe Text) Source #

JSONP