| Copyright | (c) 2015 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
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.
- type StatesClearResource = "appstate" :> ("v1" :> ("states" :> (Capture "stateKey" (Textual Int32) :> ("clear" :> (QueryParam "currentDataVersion" Text :> (QueryParam "alt" AltJSON :> Post `[JSON]` WriteResult))))))
- statesClear :: Int32 -> StatesClear
- data StatesClear
- scStateKey :: Lens' StatesClear Int32
- scCurrentDataVersion :: Lens' StatesClear (Maybe Text)
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
Arguments
| :: Int32 | |
| -> 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
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.