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.CloudScheduler.Projects.Locations.Jobs.Patch

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

See: Cloud Scheduler API Reference for cloudscheduler.projects.locations.jobs.patch.

Synopsis

type ProjectsLocationsJobsPatchResource = "v1beta1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Job :> Patch '[JSON] Job)))))))))
projectsLocationsJobsPatch :: Job -> Text -> ProjectsLocationsJobsPatch
data ProjectsLocationsJobsPatch
pljpXgafv :: Lens' ProjectsLocationsJobsPatch (Maybe Xgafv)
pljpUploadProtocol :: Lens' ProjectsLocationsJobsPatch (Maybe Text)
pljpUpdateMask :: Lens' ProjectsLocationsJobsPatch (Maybe GFieldMask)
pljpAccessToken :: Lens' ProjectsLocationsJobsPatch (Maybe Text)
pljpUploadType :: Lens' ProjectsLocationsJobsPatch (Maybe Text)
pljpPayload :: Lens' ProjectsLocationsJobsPatch Job
pljpName :: Lens' ProjectsLocationsJobsPatch Text
pljpCallback :: Lens' ProjectsLocationsJobsPatch (Maybe Text)

REST Resource

type ProjectsLocationsJobsPatchResource = "v1beta1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Job :> Patch '[JSON] Job))))))))) Source #

A resource alias for cloudscheduler.projects.locations.jobs.patch method which the ProjectsLocationsJobsPatch request conforms to.

Creating a Request

projectsLocationsJobsPatch Source #

Arguments

:: Job	`pljpPayload`
-> Text	`pljpName`
-> ProjectsLocationsJobsPatch

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

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

data ProjectsLocationsJobsPatch Source #

Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

See: projectsLocationsJobsPatch smart constructor.

Instances

Eq ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch Methods (==) :: ProjectsLocationsJobsPatch -> ProjectsLocationsJobsPatch -> Bool # (/=) :: ProjectsLocationsJobsPatch -> ProjectsLocationsJobsPatch -> Bool #
Data ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsLocationsJobsPatch -> c ProjectsLocationsJobsPatch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsLocationsJobsPatch # toConstr :: ProjectsLocationsJobsPatch -> Constr # dataTypeOf :: ProjectsLocationsJobsPatch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsLocationsJobsPatch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsLocationsJobsPatch) # gmapT :: (forall b. Data b => b -> b) -> ProjectsLocationsJobsPatch -> ProjectsLocationsJobsPatch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsJobsPatch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsJobsPatch -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsLocationsJobsPatch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsLocationsJobsPatch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsLocationsJobsPatch -> m ProjectsLocationsJobsPatch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsJobsPatch -> m ProjectsLocationsJobsPatch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsJobsPatch -> m ProjectsLocationsJobsPatch #
Show ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch Methods showsPrec :: Int -> ProjectsLocationsJobsPatch -> ShowS # show :: ProjectsLocationsJobsPatch -> String # showList :: [ProjectsLocationsJobsPatch] -> ShowS #
Generic ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch Associated Types type Rep ProjectsLocationsJobsPatch :: Type -> Type # Methods from :: ProjectsLocationsJobsPatch -> Rep ProjectsLocationsJobsPatch x # to :: Rep ProjectsLocationsJobsPatch x -> ProjectsLocationsJobsPatch #
GoogleRequest ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch Associated Types type Rs ProjectsLocationsJobsPatch :: Type # type Scopes ProjectsLocationsJobsPatch :: [Symbol] # Methods requestClient :: ProjectsLocationsJobsPatch -> GClient (Rs ProjectsLocationsJobsPatch) #
type Rep ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch type Rep ProjectsLocationsJobsPatch = D1 (MetaData "ProjectsLocationsJobsPatch" "Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch" "gogol-cloudscheduler-0.4.0-48VkVd2TeO9C5YcAbm9sQw" False) (C1 (MetaCons "ProjectsLocationsJobsPatch'" PrefixI True) (((S1 (MetaSel (Just "_pljpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_pljpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pljpUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :: S1 (MetaSel (Just "_pljpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pljpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pljpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Job)) :: (S1 (MetaSel (Just "_pljpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pljpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch type Scopes ProjectsLocationsJobsPatch = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ProjectsLocationsJobsPatch Source #
Instance details Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Patch type Rs ProjectsLocationsJobsPatch = Job

Request Lenses

pljpXgafv :: Lens' ProjectsLocationsJobsPatch (Maybe Xgafv) Source #

V1 error format.

pljpUploadProtocol :: Lens' ProjectsLocationsJobsPatch (Maybe Text) Source #

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

pljpUpdateMask :: Lens' ProjectsLocationsJobsPatch (Maybe GFieldMask) Source #

A mask used to specify which fields of the job are being updated.

pljpAccessToken :: Lens' ProjectsLocationsJobsPatch (Maybe Text) Source #

OAuth access token.

pljpUploadType :: Lens' ProjectsLocationsJobsPatch (Maybe Text) Source #

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

pljpPayload :: Lens' ProjectsLocationsJobsPatch Job Source #

Multipart request metadata.

pljpName :: Lens' ProjectsLocationsJobsPatch Text Source #

The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

pljpCallback :: Lens' ProjectsLocationsJobsPatch (Maybe Text) Source #

JSONP