| 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.StorageTransfer.TransferJobs.Patch
Description
Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.
See: Google Storage Transfer API Reference for storagetransfer.transferJobs.patch.
- type TransferJobsPatchResource = "v1" :> (Capture "jobName" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` UpdateTransferJobRequest :> Patch `[JSON]` TransferJob))))))))))
- transferJobsPatch :: Text -> UpdateTransferJobRequest -> TransferJobsPatch
- data TransferJobsPatch
- tjpXgafv :: Lens' TransferJobsPatch (Maybe Text)
- tjpUploadProtocol :: Lens' TransferJobsPatch (Maybe Text)
- tjpPp :: Lens' TransferJobsPatch Bool
- tjpAccessToken :: Lens' TransferJobsPatch (Maybe Text)
- tjpJobName :: Lens' TransferJobsPatch Text
- tjpUploadType :: Lens' TransferJobsPatch (Maybe Text)
- tjpPayload :: Lens' TransferJobsPatch UpdateTransferJobRequest
- tjpBearerToken :: Lens' TransferJobsPatch (Maybe Text)
- tjpCallback :: Lens' TransferJobsPatch (Maybe Text)
REST Resource
type TransferJobsPatchResource = "v1" :> (Capture "jobName" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` UpdateTransferJobRequest :> Patch `[JSON]` TransferJob)))))))))) Source
A resource alias for storagetransfer.transferJobs.patch method which the
TransferJobsPatch request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> UpdateTransferJobRequest | |
| -> TransferJobsPatch |
Creates a value of TransferJobsPatch with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data TransferJobsPatch Source
Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.
See: transferJobsPatch smart constructor.
Request Lenses
tjpUploadProtocol :: Lens' TransferJobsPatch (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
tjpPp :: Lens' TransferJobsPatch Bool Source
Pretty-print response.
tjpAccessToken :: Lens' TransferJobsPatch (Maybe Text) Source
OAuth access token.
tjpJobName :: Lens' TransferJobsPatch Text Source
The name of job to update. Required.
tjpUploadType :: Lens' TransferJobsPatch (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
tjpPayload :: Lens' TransferJobsPatch UpdateTransferJobRequest Source
Multipart request metadata.
tjpBearerToken :: Lens' TransferJobsPatch (Maybe Text) Source
OAuth bearer token.
tjpCallback :: Lens' TransferJobsPatch (Maybe Text) Source
JSONP