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.AppState.States.Clear

Contents

REST Resource
Creating a Request
Request Lenses

Description

Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.

See: Google App State API Reference for appstate.states.clear.

Synopsis

REST Resource

type StatesClearResource = "appstate" :> ("v1" :> ("states" :> (Capture "stateKey" (Textual Int32) :> ("clear" :> (QueryParam "currentDataVersion" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] WriteResult)))))) Source #

A resource alias for appstate.states.clear method which the StatesClear request conforms to.

Creating a Request

statesClear Source #

Arguments

:: Int32	`scStateKey`
-> StatesClear

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

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

data StatesClear Source #

Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.

See: statesClear smart constructor.

Instances

Eq StatesClear Source #
Methods (==) :: StatesClear -> StatesClear -> Bool # (/=) :: StatesClear -> StatesClear -> Bool #
Data StatesClear Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StatesClear -> c StatesClear # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StatesClear # toConstr :: StatesClear -> Constr # dataTypeOf :: StatesClear -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c StatesClear) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StatesClear) # gmapT :: (forall b. Data b => b -> b) -> StatesClear -> StatesClear # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StatesClear -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StatesClear -> r # gmapQ :: (forall d. Data d => d -> u) -> StatesClear -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StatesClear -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StatesClear -> m StatesClear # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StatesClear -> m StatesClear # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StatesClear -> m StatesClear #
Show StatesClear Source #
Methods showsPrec :: Int -> StatesClear -> ShowS # show :: StatesClear -> String # showList :: [StatesClear] -> ShowS #
Generic StatesClear Source #
Associated Types type Rep StatesClear :: * -> * # Methods from :: StatesClear -> Rep StatesClear x # to :: Rep StatesClear x -> StatesClear #
GoogleRequest StatesClear Source #
Associated Types type Rs StatesClear :: * # type Scopes StatesClear :: [Symbol] # Methods requestClient :: StatesClear -> Client (Rs StatesClear) #
type Rep StatesClear Source #
type Rep StatesClear = D1 (MetaData "StatesClear" "Network.Google.Resource.AppState.States.Clear" "gogol-appstate-0.3.0-DYTWXoCf2YjALUvm4HhtpZ" False) (C1 (MetaCons "StatesClear'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_scStateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))) (S1 (MetaSel (Just Symbol "_scCurrentDataVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Scopes StatesClear Source #
type Scopes StatesClear = (:) Symbol "https://www.googleapis.com/auth/appstate" ([] Symbol)
type Rs StatesClear Source #
type Rs StatesClear = WriteResult

Request Lenses

scStateKey :: Lens' StatesClear Int32 Source #

The key for the data to be retrieved.

scCurrentDataVersion :: Lens' StatesClear (Maybe Text) Source #

The version of the data to be cleared. Version strings are returned by the server.