gogol-resourcemanager-0.4.0: Google Cloud Resource Manager 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.CloudResourceManager.Folders.Create

Contents

Description

Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 100. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent.

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

Synopsis

REST Resource

type FoldersCreateResource = "v2" :> ("folders" :> (QueryParam "parent" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Folder :> Post '[JSON] Operation))))))))) Source #

A resource alias for cloudresourcemanager.folders.create method which the FoldersCreate request conforms to.

Creating a Request

foldersCreate Source #

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

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

data FoldersCreate Source #

Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 100. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent.

See: foldersCreate smart constructor.

Instances
Eq FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

Data FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

Methods

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

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

toConstr :: FoldersCreate -> Constr #

dataTypeOf :: FoldersCreate -> DataType #

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

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

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

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

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

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

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

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

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

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

Show FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

Generic FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

Associated Types

type Rep FoldersCreate :: Type -> Type #

GoogleRequest FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

Associated Types

type Rs FoldersCreate :: Type #

type Scopes FoldersCreate :: [Symbol] #

type Rep FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

type Rep FoldersCreate = D1 (MetaData "FoldersCreate" "Network.Google.Resource.CloudResourceManager.Folders.Create" "gogol-resourcemanager-0.4.0-UDFVnkFAEA9efzG80swCH" False) (C1 (MetaCons "FoldersCreate'" PrefixI True) ((S1 (MetaSel (Just "_fcParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_fcXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_fcUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_fcAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_fcUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_fcPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Folder) :*: S1 (MetaSel (Just "_fcCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

type Scopes FoldersCreate = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs FoldersCreate Source # 
Instance details

Defined in Network.Google.Resource.CloudResourceManager.Folders.Create

Request Lenses

fcParent :: Lens' FoldersCreate (Maybe Text) Source #

The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.

fcUploadProtocol :: Lens' FoldersCreate (Maybe Text) Source #

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

fcUploadType :: Lens' FoldersCreate (Maybe Text) Source #

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

fcPayload :: Lens' FoldersCreate Folder Source #

Multipart request metadata.