gogol-cloudscheduler-0.5.0: Google Cloud Scheduler SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

Contents

Description

Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

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

Synopsis

REST Resource

type ProjectsLocationsJobsPauseResource = "v1" :> (CaptureMode "name" "pause" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PauseJobRequest :> Post '[JSON] Job)))))))) Source #

A resource alias for cloudscheduler.projects.locations.jobs.pause method which the ProjectsLocationsJobsPause request conforms to.

Creating a Request

projectsLocationsJobsPause Source #

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

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

data ProjectsLocationsJobsPause Source #

Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

See: projectsLocationsJobsPause smart constructor.

Instances
Eq ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

Data ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsLocationsJobsPause -> c ProjectsLocationsJobsPause #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsLocationsJobsPause #

toConstr :: ProjectsLocationsJobsPause -> Constr #

dataTypeOf :: ProjectsLocationsJobsPause -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsLocationsJobsPause) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsLocationsJobsPause) #

gmapT :: (forall b. Data b => b -> b) -> ProjectsLocationsJobsPause -> ProjectsLocationsJobsPause #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsJobsPause -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsJobsPause -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProjectsLocationsJobsPause -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsLocationsJobsPause -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsLocationsJobsPause -> m ProjectsLocationsJobsPause #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsJobsPause -> m ProjectsLocationsJobsPause #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsJobsPause -> m ProjectsLocationsJobsPause #

Show ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

Generic ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

Associated Types

type Rep ProjectsLocationsJobsPause :: Type -> Type #

GoogleRequest ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

type Rep ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

type Rep ProjectsLocationsJobsPause = D1 (MetaData "ProjectsLocationsJobsPause" "Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause" "gogol-cloudscheduler-0.5.0-8JSqrzwg0pe9aK8yG5ECbq" False) (C1 (MetaCons "ProjectsLocationsJobsPause'" PrefixI True) ((S1 (MetaSel (Just "_proXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_proUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_proAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_proUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_proPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PauseJobRequest)) :*: (S1 (MetaSel (Just "_proName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_proCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

type Scopes ProjectsLocationsJobsPause = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ProjectsLocationsJobsPause Source # 
Instance details

Defined in Network.Google.Resource.CloudScheduler.Projects.Locations.Jobs.Pause

Request Lenses

proUploadProtocol :: Lens' ProjectsLocationsJobsPause (Maybe Text) Source #

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

proUploadType :: Lens' ProjectsLocationsJobsPause (Maybe Text) Source #

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

proName :: Lens' ProjectsLocationsJobsPause Text Source #

Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.