Network.Google.Resource.CloudResourceManager.Folders.Patch

Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.

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

REST Resource

type FoldersPatchResource = "v2" :> (Capture "name" 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] Folder :> Patch '[JSON] Folder)))))))))

A resource alias for cloudresourcemanager.folders.patch method which the FoldersPatch request conforms to.

Creating a Request

foldersPatch

Arguments

:: Folder

fpPayload

-> Text

fpName

-> FoldersPatch

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

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

• fpXgafv
• fpUploadProtocol
• fpUpdateMask
• fpAccessToken
• fpUploadType
• fpPayload
• fpName
• fpCallback

data FoldersPatch

Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.

See: foldersPatch smart constructor.

Instances

Eq FoldersPatch

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

Methods

(==) :: FoldersPatch -> FoldersPatch -> Bool

(/=) :: FoldersPatch -> FoldersPatch -> Bool

Data FoldersPatch

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

Methods

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

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

toConstr :: FoldersPatch -> Constr

dataTypeOf :: FoldersPatch -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> FoldersPatch -> FoldersPatch

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

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

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

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

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

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

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

Show FoldersPatch

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

Methods

showsPrec :: Int -> FoldersPatch -> ShowS

show :: FoldersPatch -> String

showList :: [FoldersPatch] -> ShowS

Generic FoldersPatch

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

Associated Types

type Rep FoldersPatch :: Type -> Type

Methods

from :: FoldersPatch -> Rep FoldersPatch x

to :: Rep FoldersPatch x -> FoldersPatch

GoogleRequest FoldersPatch

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

Associated Types

type Rs FoldersPatch :: Type

type Scopes FoldersPatch :: [Symbol]

Methods

requestClient :: FoldersPatch -> GClient (Rs FoldersPatch)

type Rep FoldersPatch

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

type Rep FoldersPatch = D1 (MetaData "FoldersPatch" "Network.Google.Resource.CloudResourceManager.Folders.Patch" "gogol-resourcemanager-0.4.0-UDFVnkFAEA9efzG80swCH" False) (C1 (MetaCons "FoldersPatch'" PrefixI True) (((S1 (MetaSel (Just "_fpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_fpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_fpUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :*: S1 (MetaSel (Just "_fpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_fpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_fpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Folder)) :*: (S1 (MetaSel (Just "_fpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_fpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes FoldersPatch

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

type Scopes FoldersPatch = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])

type Rs FoldersPatch

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

type Rs FoldersPatch = Folder

Request Lenses

fpXgafv :: Lens' FoldersPatch (Maybe Xgafv)

V1 error format.

fpUploadProtocol :: Lens' FoldersPatch (Maybe Text)

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

fpUpdateMask :: Lens' FoldersPatch (Maybe GFieldMask)

Fields to be updated. Only the `display_name` can be updated.

fpAccessToken :: Lens' FoldersPatch (Maybe Text)

OAuth access token.

fpUploadType :: Lens' FoldersPatch (Maybe Text)

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

fpPayload :: Lens' FoldersPatch Folder

Multipart request metadata.

fpName :: Lens' FoldersPatch Text

Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234".

fpCallback :: Lens' FoldersPatch (Maybe Text)

JSONP