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.BatchClearByDataFilter

Contents

REST Resource
Creating a Request
Request Lenses

Description

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. 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.batchClearByDataFilter.

Synopsis

type SpreadsheetsValuesBatchClearByDataFilterResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values:batchClearByDataFilter" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BatchClearValuesByDataFilterRequest :> Post '[JSON] BatchClearValuesByDataFilterResponse))))))))))
spreadsheetsValuesBatchClearByDataFilter :: Text -> BatchClearValuesByDataFilterRequest -> SpreadsheetsValuesBatchClearByDataFilter
data SpreadsheetsValuesBatchClearByDataFilter
svbcbdfXgafv :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Xgafv)
svbcbdfUploadProtocol :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text)
svbcbdfAccessToken :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text)
svbcbdfSpreadsheetId :: Lens' SpreadsheetsValuesBatchClearByDataFilter Text
svbcbdfUploadType :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text)
svbcbdfPayload :: Lens' SpreadsheetsValuesBatchClearByDataFilter BatchClearValuesByDataFilterRequest
svbcbdfCallback :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text)

REST Resource

type SpreadsheetsValuesBatchClearByDataFilterResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values:batchClearByDataFilter" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BatchClearValuesByDataFilterRequest :> Post '[JSON] BatchClearValuesByDataFilterResponse)))))))))) Source #

A resource alias for sheets.spreadsheets.values.batchClearByDataFilter method which the SpreadsheetsValuesBatchClearByDataFilter request conforms to.

Creating a Request

spreadsheetsValuesBatchClearByDataFilter Source #

Arguments

:: Text	`svbcbdfSpreadsheetId`
-> BatchClearValuesByDataFilterRequest	`svbcbdfPayload`
-> SpreadsheetsValuesBatchClearByDataFilter

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

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

data SpreadsheetsValuesBatchClearByDataFilter Source #

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

See: spreadsheetsValuesBatchClearByDataFilter smart constructor.

Instances

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

Request Lenses

svbcbdfXgafv :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Xgafv) Source #

V1 error format.

svbcbdfUploadProtocol :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text) Source #

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

svbcbdfAccessToken :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text) Source #

OAuth access token.

svbcbdfSpreadsheetId :: Lens' SpreadsheetsValuesBatchClearByDataFilter Text Source #

The ID of the spreadsheet to update.

svbcbdfUploadType :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text) Source #

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

svbcbdfPayload :: Lens' SpreadsheetsValuesBatchClearByDataFilter BatchClearValuesByDataFilterRequest Source #

Multipart request metadata.

svbcbdfCallback :: Lens' SpreadsheetsValuesBatchClearByDataFilter (Maybe Text) Source #

JSONP