Network.Google.Resource.StorageTransfer.TransferJobs.Patch

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.

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))))))))))

A resource alias for storagetransfer.transferJobs.patch method which the TransferJobsPatch request conforms to.

Creating a Request

transferJobsPatch

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:

• tjpXgafv
• tjpUploadProtocol
• tjpPp
• tjpAccessToken
• tjpJobName
• tjpUploadType
• tjpPayload
• tjpBearerToken
• tjpCallback

data TransferJobsPatch

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

Methods

(==) :: TransferJobsPatch -> TransferJobsPatch -> Bool

(/=) :: TransferJobsPatch -> TransferJobsPatch -> Bool

Data TransferJobsPatch

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

Methods

showsPrec :: Int -> TransferJobsPatch -> ShowS

show :: TransferJobsPatch -> String

showList :: [TransferJobsPatch] -> ShowS

Generic TransferJobsPatch

Associated Types

type Rep TransferJobsPatch :: * -> *

Methods

from :: TransferJobsPatch -> Rep TransferJobsPatch x

to :: Rep TransferJobsPatch x -> TransferJobsPatch

GoogleRequest TransferJobsPatch

Associated Types

type Rs TransferJobsPatch :: *

type Scopes TransferJobsPatch :: [Symbol]

Methods

requestClient :: TransferJobsPatch -> Client (Rs TransferJobsPatch)

type Rep TransferJobsPatch

type Rep TransferJobsPatch = D1 (MetaData "TransferJobsPatch" "Network.Google.Resource.StorageTransfer.TransferJobs.Patch" "gogol-storage-transfer-0.3.0-DdvgDN2DYSs8eCRR6oXdxh" False) (C1 (MetaCons "TransferJobsPatch'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tjpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tjpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_tjpPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_tjpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tjpJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_tjpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_tjpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UpdateTransferJobRequest)) ((:*:) (S1 (MetaSel (Just Symbol "_tjpBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tjpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes TransferJobsPatch

type Scopes TransferJobsPatch = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ([] Symbol)

type Rs TransferJobsPatch

type Rs TransferJobsPatch = TransferJob

Request Lenses

tjpXgafv :: Lens' TransferJobsPatch (Maybe Text)

V1 error format.

tjpUploadProtocol :: Lens' TransferJobsPatch (Maybe Text)

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

tjpPp :: Lens' TransferJobsPatch Bool

Pretty-print response.

tjpAccessToken :: Lens' TransferJobsPatch (Maybe Text)

OAuth access token.

tjpJobName :: Lens' TransferJobsPatch Text

The name of job to update. Required.

tjpUploadType :: Lens' TransferJobsPatch (Maybe Text)

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

tjpPayload :: Lens' TransferJobsPatch UpdateTransferJobRequest

Multipart request metadata.

tjpBearerToken :: Lens' TransferJobsPatch (Maybe Text)

OAuth bearer token.

tjpCallback :: Lens' TransferJobsPatch (Maybe Text)

JSONP