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.Storage.Objects.Delete

Contents

REST Resource
Creating a Request
Request Lenses

Description

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.

See: Cloud Storage JSON API Reference for storage.objects.delete.

Synopsis

type ObjectsDeleteResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (Capture "object" Text :> (QueryParam "ifMetagenerationMatch" (Textual Int64) :> (QueryParam "ifGenerationNotMatch" (Textual Int64) :> (QueryParam "ifGenerationMatch" (Textual Int64) :> (QueryParam "userProject" Text :> (QueryParam "ifMetagenerationNotMatch" (Textual Int64) :> (QueryParam "generation" (Textual Int64) :> (QueryParam "alt" AltJSON :> Delete '[JSON] ()))))))))))))
objectsDelete :: Text -> Text -> ObjectsDelete
data ObjectsDelete
odIfMetagenerationMatch :: Lens' ObjectsDelete (Maybe Int64)
odIfGenerationNotMatch :: Lens' ObjectsDelete (Maybe Int64)
odIfGenerationMatch :: Lens' ObjectsDelete (Maybe Int64)
odBucket :: Lens' ObjectsDelete Text
odUserProject :: Lens' ObjectsDelete (Maybe Text)
odIfMetagenerationNotMatch :: Lens' ObjectsDelete (Maybe Int64)
odObject :: Lens' ObjectsDelete Text
odGeneration :: Lens' ObjectsDelete (Maybe Int64)

REST Resource

type ObjectsDeleteResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (Capture "object" Text :> (QueryParam "ifMetagenerationMatch" (Textual Int64) :> (QueryParam "ifGenerationNotMatch" (Textual Int64) :> (QueryParam "ifGenerationMatch" (Textual Int64) :> (QueryParam "userProject" Text :> (QueryParam "ifMetagenerationNotMatch" (Textual Int64) :> (QueryParam "generation" (Textual Int64) :> (QueryParam "alt" AltJSON :> Delete '[JSON] ())))))))))))) Source #

A resource alias for storage.objects.delete method which the ObjectsDelete request conforms to.

Creating a Request

objectsDelete Source #

Arguments

:: Text	`odBucket`
-> Text	`odObject`
-> ObjectsDelete

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

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

data ObjectsDelete Source #

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.

See: objectsDelete smart constructor.

Instances

Eq ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete Methods (==) :: ObjectsDelete -> ObjectsDelete -> Bool # (/=) :: ObjectsDelete -> ObjectsDelete -> Bool #
Data ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ObjectsDelete -> c ObjectsDelete # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ObjectsDelete # toConstr :: ObjectsDelete -> Constr # dataTypeOf :: ObjectsDelete -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ObjectsDelete) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ObjectsDelete) # gmapT :: (forall b. Data b => b -> b) -> ObjectsDelete -> ObjectsDelete # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ObjectsDelete -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ObjectsDelete -> r # gmapQ :: (forall d. Data d => d -> u) -> ObjectsDelete -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ObjectsDelete -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ObjectsDelete -> m ObjectsDelete # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ObjectsDelete -> m ObjectsDelete # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ObjectsDelete -> m ObjectsDelete #
Show ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete Methods showsPrec :: Int -> ObjectsDelete -> ShowS # show :: ObjectsDelete -> String # showList :: [ObjectsDelete] -> ShowS #
Generic ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete Associated Types type Rep ObjectsDelete :: Type -> Type # Methods from :: ObjectsDelete -> Rep ObjectsDelete x # to :: Rep ObjectsDelete x -> ObjectsDelete #
GoogleRequest ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete Associated Types type Rs ObjectsDelete :: Type # type Scopes ObjectsDelete :: [Symbol] # Methods requestClient :: ObjectsDelete -> GClient (Rs ObjectsDelete) #
type Rep ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete type Rep ObjectsDelete = D1 (MetaData "ObjectsDelete" "Network.Google.Resource.Storage.Objects.Delete" "gogol-storage-0.4.0-F1QXZopXJqf9Y2QJKwfuR3" False) (C1 (MetaCons "ObjectsDelete'" PrefixI True) (((S1 (MetaSel (Just "_odIfMetagenerationMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :: S1 (MetaSel (Just "_odIfGenerationNotMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :: (S1 (MetaSel (Just "_odIfGenerationMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :: S1 (MetaSel (Just "_odBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_odUserProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_odIfMetagenerationNotMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :: (S1 (MetaSel (Just "_odObject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_odGeneration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))))))
type Scopes ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete type Scopes ObjectsDelete = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/devstorage.full_control" ': ("https://www.googleapis.com/auth/devstorage.read_write" ': ([] :: [Symbol])))
type Rs ObjectsDelete Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.Delete type Rs ObjectsDelete = ()

Request Lenses

odIfMetagenerationMatch :: Lens' ObjectsDelete (Maybe Int64) Source #

Makes the operation conditional on whether the object's current metageneration matches the given value.

odIfGenerationNotMatch :: Lens' ObjectsDelete (Maybe Int64) Source #

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

odIfGenerationMatch :: Lens' ObjectsDelete (Maybe Int64) Source #

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

odBucket :: Lens' ObjectsDelete Text Source #

Name of the bucket in which the object resides.

odUserProject :: Lens' ObjectsDelete (Maybe Text) Source #

The project to be billed for this request. Required for Requester Pays buckets.

odIfMetagenerationNotMatch :: Lens' ObjectsDelete (Maybe Int64) Source #

Makes the operation conditional on whether the object's current metageneration does not match the given value.

odObject :: Lens' ObjectsDelete Text Source #

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

odGeneration :: Lens' ObjectsDelete (Maybe Int64) Source #

If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).