gogol-drive-0.0.1: gen/Network/Google/Resource/Drive/Files/Update.hs
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
-- |
-- Module : Network.Google.Resource.Drive.Files.Update
-- 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)
--
-- Updates file metadata and\/or content.
--
-- /See:/ <https://developers.google.com/drive/ Drive API Reference> for @drive.files.update@.
module Network.Google.Resource.Drive.Files.Update
(
-- * REST Resource
FilesUpdateResource
-- * Creating a Request
, filesUpdate
, FilesUpdate
-- * Request Lenses
, fuNewRevision
, fuPinned
, fuTimedTextLanguage
, fuPayload
, fuUpdateViewedDate
, fuRemoveParents
, fuModifiedDateBehavior
, fuUseContentAsIndexableText
, fuTimedTextTrackName
, fuOCRLanguage
, fuConvert
, fuSetModifiedDate
, fuFileId
, fuAddParents
, fuOCR
) where
import Network.Google.Drive.Types
import Network.Google.Prelude
-- | A resource alias for @drive.files.update@ method which the
-- 'FilesUpdate' request conforms to.
type FilesUpdateResource =
"drive" :>
"v2" :>
"files" :>
Capture "fileId" Text :>
QueryParam "newRevision" Bool :>
QueryParam "pinned" Bool :>
QueryParam "timedTextLanguage" Text :>
QueryParam "updateViewedDate" Bool :>
QueryParam "removeParents" Text :>
QueryParam "modifiedDateBehavior"
FilesUpdateModifiedDateBehavior
:>
QueryParam "useContentAsIndexableText" Bool :>
QueryParam "timedTextTrackName" Text :>
QueryParam "ocrLanguage" Text :>
QueryParam "convert" Bool :>
QueryParam "setModifiedDate" Bool :>
QueryParam "addParents" Text :>
QueryParam "ocr" Bool :>
QueryParam "alt" AltJSON :>
ReqBody '[JSON] File :>
Put '[JSON] File
:<|>
"upload" :>
"drive" :>
"v2" :>
"files" :>
Capture "fileId" Text :>
QueryParam "newRevision" Bool :>
QueryParam "pinned" Bool :>
QueryParam "timedTextLanguage" Text :>
QueryParam "updateViewedDate" Bool :>
QueryParam "removeParents" Text :>
QueryParam "modifiedDateBehavior"
FilesUpdateModifiedDateBehavior
:>
QueryParam "useContentAsIndexableText" Bool :>
QueryParam "timedTextTrackName" Text :>
QueryParam "ocrLanguage" Text :>
QueryParam "convert" Bool :>
QueryParam "setModifiedDate" Bool :>
QueryParam "addParents" Text :>
QueryParam "ocr" Bool :>
QueryParam "alt" AltJSON :>
QueryParam "uploadType" AltMedia :>
MultipartRelated '[JSON] File
RequestBody
:> Put '[JSON] File
-- | Updates file metadata and\/or content.
--
-- /See:/ 'filesUpdate' smart constructor.
data FilesUpdate = FilesUpdate
{ _fuNewRevision :: !Bool
, _fuPinned :: !Bool
, _fuTimedTextLanguage :: !(Maybe Text)
, _fuPayload :: !File
, _fuUpdateViewedDate :: !Bool
, _fuRemoveParents :: !(Maybe Text)
, _fuModifiedDateBehavior :: !(Maybe FilesUpdateModifiedDateBehavior)
, _fuUseContentAsIndexableText :: !Bool
, _fuTimedTextTrackName :: !(Maybe Text)
, _fuOCRLanguage :: !(Maybe Text)
, _fuConvert :: !Bool
, _fuSetModifiedDate :: !Bool
, _fuFileId :: !Text
, _fuAddParents :: !(Maybe Text)
, _fuOCR :: !Bool
} deriving (Eq,Show,Data,Typeable,Generic)
-- | Creates a value of 'FilesUpdate' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'fuNewRevision'
--
-- * 'fuPinned'
--
-- * 'fuTimedTextLanguage'
--
-- * 'fuPayload'
--
-- * 'fuUpdateViewedDate'
--
-- * 'fuRemoveParents'
--
-- * 'fuModifiedDateBehavior'
--
-- * 'fuUseContentAsIndexableText'
--
-- * 'fuTimedTextTrackName'
--
-- * 'fuOCRLanguage'
--
-- * 'fuConvert'
--
-- * 'fuSetModifiedDate'
--
-- * 'fuFileId'
--
-- * 'fuAddParents'
--
-- * 'fuOCR'
filesUpdate
:: File -- ^ 'fuPayload'
-> Text -- ^ 'fuFileId'
-> FilesUpdate
filesUpdate pFuPayload_ pFuFileId_ =
FilesUpdate
{ _fuNewRevision = True
, _fuPinned = False
, _fuTimedTextLanguage = Nothing
, _fuPayload = pFuPayload_
, _fuUpdateViewedDate = True
, _fuRemoveParents = Nothing
, _fuModifiedDateBehavior = Nothing
, _fuUseContentAsIndexableText = False
, _fuTimedTextTrackName = Nothing
, _fuOCRLanguage = Nothing
, _fuConvert = False
, _fuSetModifiedDate = False
, _fuFileId = pFuFileId_
, _fuAddParents = Nothing
, _fuOCR = False
}
-- | Whether a blob upload should create a new revision. If false, the blob
-- data in the current head revision is replaced. If true or not set, a new
-- blob is created as head revision, and previous unpinned revisions are
-- preserved for a short period of time. Pinned revisions are stored
-- indefinitely, using additional storage quota, up to a maximum of 200
-- revisions. For details on how revisions are retained, see the Drive Help
-- Center.
fuNewRevision :: Lens' FilesUpdate Bool
fuNewRevision
= lens _fuNewRevision
(\ s a -> s{_fuNewRevision = a})
-- | Whether to pin the new revision. A file can have a maximum of 200 pinned
-- revisions.
fuPinned :: Lens' FilesUpdate Bool
fuPinned = lens _fuPinned (\ s a -> s{_fuPinned = a})
-- | The language of the timed text.
fuTimedTextLanguage :: Lens' FilesUpdate (Maybe Text)
fuTimedTextLanguage
= lens _fuTimedTextLanguage
(\ s a -> s{_fuTimedTextLanguage = a})
-- | Multipart request metadata.
fuPayload :: Lens' FilesUpdate File
fuPayload
= lens _fuPayload (\ s a -> s{_fuPayload = a})
-- | Whether to update the view date after successfully updating the file.
fuUpdateViewedDate :: Lens' FilesUpdate Bool
fuUpdateViewedDate
= lens _fuUpdateViewedDate
(\ s a -> s{_fuUpdateViewedDate = a})
-- | Comma-separated list of parent IDs to remove.
fuRemoveParents :: Lens' FilesUpdate (Maybe Text)
fuRemoveParents
= lens _fuRemoveParents
(\ s a -> s{_fuRemoveParents = a})
-- | Determines the behavior in which modifiedDate is updated. This overrides
-- setModifiedDate.
fuModifiedDateBehavior :: Lens' FilesUpdate (Maybe FilesUpdateModifiedDateBehavior)
fuModifiedDateBehavior
= lens _fuModifiedDateBehavior
(\ s a -> s{_fuModifiedDateBehavior = a})
-- | Whether to use the content as indexable text.
fuUseContentAsIndexableText :: Lens' FilesUpdate Bool
fuUseContentAsIndexableText
= lens _fuUseContentAsIndexableText
(\ s a -> s{_fuUseContentAsIndexableText = a})
-- | The timed text track name.
fuTimedTextTrackName :: Lens' FilesUpdate (Maybe Text)
fuTimedTextTrackName
= lens _fuTimedTextTrackName
(\ s a -> s{_fuTimedTextTrackName = a})
-- | If ocr is true, hints at the language to use. Valid values are BCP 47
-- codes.
fuOCRLanguage :: Lens' FilesUpdate (Maybe Text)
fuOCRLanguage
= lens _fuOCRLanguage
(\ s a -> s{_fuOCRLanguage = a})
-- | This parameter is deprecated and has no function.
fuConvert :: Lens' FilesUpdate Bool
fuConvert
= lens _fuConvert (\ s a -> s{_fuConvert = a})
-- | Whether to set the modified date with the supplied modified date.
fuSetModifiedDate :: Lens' FilesUpdate Bool
fuSetModifiedDate
= lens _fuSetModifiedDate
(\ s a -> s{_fuSetModifiedDate = a})
-- | The ID of the file to update.
fuFileId :: Lens' FilesUpdate Text
fuFileId = lens _fuFileId (\ s a -> s{_fuFileId = a})
-- | Comma-separated list of parent IDs to add.
fuAddParents :: Lens' FilesUpdate (Maybe Text)
fuAddParents
= lens _fuAddParents (\ s a -> s{_fuAddParents = a})
-- | Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
fuOCR :: Lens' FilesUpdate Bool
fuOCR = lens _fuOCR (\ s a -> s{_fuOCR = a})
instance GoogleRequest FilesUpdate where
type Rs FilesUpdate = File
requestClient FilesUpdate{..}
= go _fuFileId (Just _fuNewRevision) (Just _fuPinned)
_fuTimedTextLanguage
(Just _fuUpdateViewedDate)
_fuRemoveParents
_fuModifiedDateBehavior
(Just _fuUseContentAsIndexableText)
_fuTimedTextTrackName
_fuOCRLanguage
(Just _fuConvert)
(Just _fuSetModifiedDate)
_fuAddParents
(Just _fuOCR)
(Just AltJSON)
_fuPayload
driveService
where go :<|> _
= buildClient (Proxy :: Proxy FilesUpdateResource)
mempty
instance GoogleRequest (MediaUpload FilesUpdate)
where
type Rs (MediaUpload FilesUpdate) = File
requestClient (MediaUpload FilesUpdate{..} body)
= go _fuFileId (Just _fuNewRevision) (Just _fuPinned)
_fuTimedTextLanguage
(Just _fuUpdateViewedDate)
_fuRemoveParents
_fuModifiedDateBehavior
(Just _fuUseContentAsIndexableText)
_fuTimedTextTrackName
_fuOCRLanguage
(Just _fuConvert)
(Just _fuSetModifiedDate)
_fuAddParents
(Just _fuOCR)
(Just AltJSON)
(Just AltMedia)
_fuPayload
body
driveService
where _ :<|> go
= buildClient (Proxy :: Proxy FilesUpdateResource)
mempty