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.StorageTransfer.TransferJobs.Patch

Contents

REST Resource
Creating a Request
Request Lenses

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: Storage Transfer API Reference for storagetransfer.transferJobs.patch.

Synopsis

type TransferJobsPatchResource = "v1" :> (Capture "jobName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] UpdateTransferJobRequest :> Patch '[JSON] TransferJob))))))))
transferJobsPatch :: Text -> UpdateTransferJobRequest -> TransferJobsPatch
data TransferJobsPatch
tjpXgafv :: Lens' TransferJobsPatch (Maybe Xgafv)
tjpUploadProtocol :: Lens' TransferJobsPatch (Maybe Text)
tjpAccessToken :: Lens' TransferJobsPatch (Maybe Text)
tjpJobName :: Lens' TransferJobsPatch Text
tjpUploadType :: Lens' TransferJobsPatch (Maybe Text)
tjpPayload :: Lens' TransferJobsPatch UpdateTransferJobRequest
tjpCallback :: Lens' TransferJobsPatch (Maybe Text)

REST Resource

type TransferJobsPatchResource = "v1" :> (Capture "jobName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" 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

transferJobsPatch Source #

Arguments

:: Text	`tjpJobName`
-> UpdateTransferJobRequest	`tjpPayload`
-> 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.

Instances

Eq TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch Methods (==) :: TransferJobsPatch -> TransferJobsPatch -> Bool # (/=) :: TransferJobsPatch -> TransferJobsPatch -> Bool #
Data TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TransferJobsPatch -> c TransferJobsPatch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TransferJobsPatch # toConstr :: TransferJobsPatch -> Constr # dataTypeOf :: TransferJobsPatch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TransferJobsPatch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TransferJobsPatch) # gmapT :: (forall b. Data b => b -> b) -> TransferJobsPatch -> TransferJobsPatch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TransferJobsPatch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TransferJobsPatch -> r # gmapQ :: (forall d. Data d => d -> u) -> TransferJobsPatch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> TransferJobsPatch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TransferJobsPatch -> m TransferJobsPatch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TransferJobsPatch -> m TransferJobsPatch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TransferJobsPatch -> m TransferJobsPatch #
Show TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch Methods showsPrec :: Int -> TransferJobsPatch -> ShowS # show :: TransferJobsPatch -> String # showList :: [TransferJobsPatch] -> ShowS #
Generic TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch Associated Types type Rep TransferJobsPatch :: Type -> Type # Methods from :: TransferJobsPatch -> Rep TransferJobsPatch x # to :: Rep TransferJobsPatch x -> TransferJobsPatch #
GoogleRequest TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch Associated Types type Rs TransferJobsPatch :: Type # type Scopes TransferJobsPatch :: [Symbol] # Methods requestClient :: TransferJobsPatch -> GClient (Rs TransferJobsPatch) #
type Rep TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch type Rep TransferJobsPatch = D1 (MetaData "TransferJobsPatch" "Network.Google.Resource.StorageTransfer.TransferJobs.Patch" "gogol-storage-transfer-0.4.0-GGwHgHZplO0LWcGDc7JAZR" False) (C1 (MetaCons "TransferJobsPatch'" PrefixI True) ((S1 (MetaSel (Just "_tjpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_tjpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_tjpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_tjpJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_tjpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_tjpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UpdateTransferJobRequest) :: S1 (MetaSel (Just "_tjpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch type Scopes TransferJobsPatch = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs TransferJobsPatch Source #
Instance details Defined in Network.Google.Resource.StorageTransfer.TransferJobs.Patch type Rs TransferJobsPatch = TransferJob

Request Lenses

tjpXgafv :: Lens' TransferJobsPatch (Maybe Xgafv) Source #

V1 error format.

tjpUploadProtocol :: Lens' TransferJobsPatch (Maybe Text) Source #

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

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.

tjpCallback :: Lens' TransferJobsPatch (Maybe Text) Source #

JSONP