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.CloudResourceManager.Folders.Move

Contents

REST Resource
Creating a Request
Request Lenses

Description

Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent.

See: Cloud Resource Manager API Reference for cloudresourcemanager.folders.move.

Synopsis

type FoldersMoveResource = "v2" :> (CaptureMode "name" "move" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] MoveFolderRequest :> Post '[JSON] Operation))))))))
foldersMove :: MoveFolderRequest -> Text -> FoldersMove
data FoldersMove
fmXgafv :: Lens' FoldersMove (Maybe Xgafv)
fmUploadProtocol :: Lens' FoldersMove (Maybe Text)
fmAccessToken :: Lens' FoldersMove (Maybe Text)
fmUploadType :: Lens' FoldersMove (Maybe Text)
fmPayload :: Lens' FoldersMove MoveFolderRequest
fmName :: Lens' FoldersMove Text
fmCallback :: Lens' FoldersMove (Maybe Text)

REST Resource

type FoldersMoveResource = "v2" :> (CaptureMode "name" "move" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] MoveFolderRequest :> Post '[JSON] Operation)))))))) Source #

A resource alias for cloudresourcemanager.folders.move method which the FoldersMove request conforms to.

Creating a Request

foldersMove Source #

Arguments

:: MoveFolderRequest	`fmPayload`
-> Text	`fmName`
-> FoldersMove

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

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

data FoldersMove Source #

Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent.

See: foldersMove smart constructor.

Instances

Eq FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move Methods (==) :: FoldersMove -> FoldersMove -> Bool # (/=) :: FoldersMove -> FoldersMove -> Bool #
Data FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FoldersMove -> c FoldersMove # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FoldersMove # toConstr :: FoldersMove -> Constr # dataTypeOf :: FoldersMove -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FoldersMove) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FoldersMove) # gmapT :: (forall b. Data b => b -> b) -> FoldersMove -> FoldersMove # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FoldersMove -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FoldersMove -> r # gmapQ :: (forall d. Data d => d -> u) -> FoldersMove -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FoldersMove -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FoldersMove -> m FoldersMove # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FoldersMove -> m FoldersMove # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FoldersMove -> m FoldersMove #
Show FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move Methods showsPrec :: Int -> FoldersMove -> ShowS # show :: FoldersMove -> String # showList :: [FoldersMove] -> ShowS #
Generic FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move Associated Types type Rep FoldersMove :: Type -> Type # Methods from :: FoldersMove -> Rep FoldersMove x # to :: Rep FoldersMove x -> FoldersMove #
GoogleRequest FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move Associated Types type Rs FoldersMove :: Type # type Scopes FoldersMove :: [Symbol] # Methods requestClient :: FoldersMove -> GClient (Rs FoldersMove) #
type Rep FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move type Rep FoldersMove = D1 (MetaData "FoldersMove" "Network.Google.Resource.CloudResourceManager.Folders.Move" "gogol-resourcemanager-0.4.0-UDFVnkFAEA9efzG80swCH" False) (C1 (MetaCons "FoldersMove'" PrefixI True) ((S1 (MetaSel (Just "_fmXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_fmUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_fmAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_fmUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_fmPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 MoveFolderRequest)) :: (S1 (MetaSel (Just "_fmName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_fmCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move type Scopes FoldersMove = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs FoldersMove Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.Move type Rs FoldersMove = Operation

Request Lenses

fmXgafv :: Lens' FoldersMove (Maybe Xgafv) Source #

V1 error format.

fmUploadProtocol :: Lens' FoldersMove (Maybe Text) Source #

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

fmAccessToken :: Lens' FoldersMove (Maybe Text) Source #

OAuth access token.

fmUploadType :: Lens' FoldersMove (Maybe Text) Source #

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

fmPayload :: Lens' FoldersMove MoveFolderRequest Source #

Multipart request metadata.

fmName :: Lens' FoldersMove Text Source #

The resource name of the Folder to move. Must be of the form folders/{folder_id}

fmCallback :: Lens' FoldersMove (Maybe Text) Source #

JSONP