gogol-storage-0.4.0: Google Cloud Storage JSON 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.Storage.Objects.Patch

Contents

Description

Patches an object's metadata.

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

Synopsis

REST Resource

type ObjectsPatchResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (Capture "object" Text :> (QueryParam "ifMetagenerationMatch" (Textual Int64) :> (QueryParam "ifGenerationNotMatch" (Textual Int64) :> (QueryParam "ifGenerationMatch" (Textual Int64) :> (QueryParam "predefinedAcl" ObjectsPatchPredefinedACL :> (QueryParam "userProject" Text :> (QueryParam "ifMetagenerationNotMatch" (Textual Int64) :> (QueryParam "projection" ObjectsPatchProjection :> (QueryParam "generation" (Textual Int64) :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Object :> Patch '[JSON] Object))))))))))))))) Source #

A resource alias for storage.objects.patch method which the ObjectsPatch request conforms to.

Creating a Request

objectsPatch Source #

Arguments

:: Text

opBucket

-> Object

opPayload

-> Text

opObject

-> ObjectsPatch 

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

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

data ObjectsPatch Source #

Patches an object's metadata.

See: objectsPatch smart constructor.

Instances
Eq ObjectsPatch Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Patch

Methods

(==) :: ObjectsPatch -> ObjectsPatch -> Bool #

(/=) :: ObjectsPatch -> ObjectsPatch -> Bool #

Data ObjectsPatch Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Patch

Methods

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

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

toConstr :: ObjectsPatch -> Constr #

dataTypeOf :: ObjectsPatch -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ObjectsPatch Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Patch

Methods

showsPrec :: Int -> ObjectsPatch -> ShowS #

show :: ObjectsPatch -> String #

showList :: [ObjectsPatch] -> ShowS #

Generic ObjectsPatch Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Patch

Associated Types

type Rep ObjectsPatch :: Type -> Type #

Methods

from :: ObjectsPatch -> Rep ObjectsPatch x #

to :: Rep ObjectsPatch x -> ObjectsPatch #

GoogleRequest ObjectsPatch Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Patch

Associated Types

type Rs ObjectsPatch :: Type #

type Scopes ObjectsPatch :: [Symbol] #

Methods

requestClient :: ObjectsPatch -> GClient (Rs ObjectsPatch) #

type Rep ObjectsPatch Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Patch

type Rep ObjectsPatch = D1 (MetaData "ObjectsPatch" "Network.Google.Resource.Storage.Objects.Patch" "gogol-storage-0.4.0-F1QXZopXJqf9Y2QJKwfuR3" False) (C1 (MetaCons "ObjectsPatch'" PrefixI True) (((S1 (MetaSel (Just "_opIfMetagenerationMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_opIfGenerationNotMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :*: (S1 (MetaSel (Just "_opIfGenerationMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_opPredefinedACL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ObjectsPatchPredefinedACL)) :*: S1 (MetaSel (Just "_opBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :*: ((S1 (MetaSel (Just "_opPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Object) :*: (S1 (MetaSel (Just "_opUserProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_opIfMetagenerationNotMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))) :*: (S1 (MetaSel (Just "_opObject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_opProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ObjectsPatchProjection)) :*: S1 (MetaSel (Just "_opGeneration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))))))
type Scopes ObjectsPatch Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Patch

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

Defined in Network.Google.Resource.Storage.Objects.Patch

type Rs ObjectsPatch = Object

Request Lenses

opIfMetagenerationMatch :: Lens' ObjectsPatch (Maybe Int64) Source #

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

opIfGenerationNotMatch :: Lens' ObjectsPatch (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.

opIfGenerationMatch :: Lens' ObjectsPatch (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.

opPredefinedACL :: Lens' ObjectsPatch (Maybe ObjectsPatchPredefinedACL) Source #

Apply a predefined set of access controls to this object.

opBucket :: Lens' ObjectsPatch Text Source #

Name of the bucket in which the object resides.

opPayload :: Lens' ObjectsPatch Object Source #

Multipart request metadata.

opUserProject :: Lens' ObjectsPatch (Maybe Text) Source #

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

opIfMetagenerationNotMatch :: Lens' ObjectsPatch (Maybe Int64) Source #

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

opObject :: Lens' ObjectsPatch Text Source #

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

opProjection :: Lens' ObjectsPatch (Maybe ObjectsPatchProjection) Source #

Set of properties to return. Defaults to full.

opGeneration :: Lens' ObjectsPatch (Maybe Int64) Source #

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