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.Sheets.Spreadsheets.Values.Clear

Contents

REST Resource
Creating a Request
Request Lenses

Description

Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

See: Google Sheets API Reference for sheets.spreadsheets.values.clear.

Synopsis

type SpreadsheetsValuesClearResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values" :> (CaptureMode "range" "clear" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ClearValuesRequest :> Post '[JSON] ClearValuesResponse)))))))))))
spreadsheetsValuesClear :: Text -> ClearValuesRequest -> Text -> SpreadsheetsValuesClear
data SpreadsheetsValuesClear
svcXgafv :: Lens' SpreadsheetsValuesClear (Maybe Xgafv)
svcUploadProtocol :: Lens' SpreadsheetsValuesClear (Maybe Text)
svcAccessToken :: Lens' SpreadsheetsValuesClear (Maybe Text)
svcSpreadsheetId :: Lens' SpreadsheetsValuesClear Text
svcUploadType :: Lens' SpreadsheetsValuesClear (Maybe Text)
svcPayload :: Lens' SpreadsheetsValuesClear ClearValuesRequest
svcRange :: Lens' SpreadsheetsValuesClear Text
svcCallback :: Lens' SpreadsheetsValuesClear (Maybe Text)

REST Resource

type SpreadsheetsValuesClearResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values" :> (CaptureMode "range" "clear" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ClearValuesRequest :> Post '[JSON] ClearValuesResponse))))))))))) Source #

A resource alias for sheets.spreadsheets.values.clear method which the SpreadsheetsValuesClear request conforms to.

Creating a Request

spreadsheetsValuesClear Source #

Arguments

:: Text	`svcSpreadsheetId`
-> ClearValuesRequest	`svcPayload`
-> Text	`svcRange`
-> SpreadsheetsValuesClear

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

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

data SpreadsheetsValuesClear Source #

Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

See: spreadsheetsValuesClear smart constructor.

Instances

Eq SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear Methods (==) :: SpreadsheetsValuesClear -> SpreadsheetsValuesClear -> Bool # (/=) :: SpreadsheetsValuesClear -> SpreadsheetsValuesClear -> Bool #
Data SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SpreadsheetsValuesClear -> c SpreadsheetsValuesClear # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SpreadsheetsValuesClear # toConstr :: SpreadsheetsValuesClear -> Constr # dataTypeOf :: SpreadsheetsValuesClear -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SpreadsheetsValuesClear) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SpreadsheetsValuesClear) # gmapT :: (forall b. Data b => b -> b) -> SpreadsheetsValuesClear -> SpreadsheetsValuesClear # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsValuesClear -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsValuesClear -> r # gmapQ :: (forall d. Data d => d -> u) -> SpreadsheetsValuesClear -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SpreadsheetsValuesClear -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesClear -> m SpreadsheetsValuesClear # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesClear -> m SpreadsheetsValuesClear # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesClear -> m SpreadsheetsValuesClear #
Show SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear Methods showsPrec :: Int -> SpreadsheetsValuesClear -> ShowS # show :: SpreadsheetsValuesClear -> String # showList :: [SpreadsheetsValuesClear] -> ShowS #
Generic SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear Associated Types type Rep SpreadsheetsValuesClear :: Type -> Type # Methods from :: SpreadsheetsValuesClear -> Rep SpreadsheetsValuesClear x # to :: Rep SpreadsheetsValuesClear x -> SpreadsheetsValuesClear #
GoogleRequest SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear Associated Types type Rs SpreadsheetsValuesClear :: Type # type Scopes SpreadsheetsValuesClear :: [Symbol] # Methods requestClient :: SpreadsheetsValuesClear -> GClient (Rs SpreadsheetsValuesClear) #
type Rep SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear type Rep SpreadsheetsValuesClear = D1 (MetaData "SpreadsheetsValuesClear" "Network.Google.Resource.Sheets.Spreadsheets.Values.Clear" "gogol-sheets-0.4.0-DWkMVDpj7ZbHiXYeCjugGu" False) (C1 (MetaCons "SpreadsheetsValuesClear'" PrefixI True) (((S1 (MetaSel (Just "_svcXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_svcUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_svcAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_svcSpreadsheetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_svcUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_svcPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ClearValuesRequest)) :: (S1 (MetaSel (Just "_svcRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_svcCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear type Scopes SpreadsheetsValuesClear = "https://www.googleapis.com/auth/drive" ': ("https://www.googleapis.com/auth/drive.file" ': ("https://www.googleapis.com/auth/spreadsheets" ': ([] :: [Symbol])))
type Rs SpreadsheetsValuesClear Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Clear type Rs SpreadsheetsValuesClear = ClearValuesResponse

Request Lenses

svcXgafv :: Lens' SpreadsheetsValuesClear (Maybe Xgafv) Source #

V1 error format.

svcUploadProtocol :: Lens' SpreadsheetsValuesClear (Maybe Text) Source #

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

svcAccessToken :: Lens' SpreadsheetsValuesClear (Maybe Text) Source #

OAuth access token.

svcSpreadsheetId :: Lens' SpreadsheetsValuesClear Text Source #

The ID of the spreadsheet to update.

svcUploadType :: Lens' SpreadsheetsValuesClear (Maybe Text) Source #

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

svcPayload :: Lens' SpreadsheetsValuesClear ClearValuesRequest Source #

Multipart request metadata.

svcRange :: Lens' SpreadsheetsValuesClear Text Source #

The A1 notation of the values to clear.

svcCallback :: Lens' SpreadsheetsValuesClear (Maybe Text) Source #

JSONP