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.Run

Contents

REST Resource
Creating a Request
Request Lenses

Description

Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

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

Synopsis

type ProjectsLocationsJobsRunResource = "v1beta1" :> (CaptureMode "name" "run" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RunJobRequest :> Post '[JSON] Job))))))))
projectsLocationsJobsRun :: RunJobRequest -> Text -> ProjectsLocationsJobsRun
data ProjectsLocationsJobsRun
pXgafv :: Lens' ProjectsLocationsJobsRun (Maybe Xgafv)
pUploadProtocol :: Lens' ProjectsLocationsJobsRun (Maybe Text)
pAccessToken :: Lens' ProjectsLocationsJobsRun (Maybe Text)
pUploadType :: Lens' ProjectsLocationsJobsRun (Maybe Text)
pPayload :: Lens' ProjectsLocationsJobsRun RunJobRequest
pName :: Lens' ProjectsLocationsJobsRun Text
pCallback :: Lens' ProjectsLocationsJobsRun (Maybe Text)

REST Resource

type ProjectsLocationsJobsRunResource = "v1beta1" :> (CaptureMode "name" "run" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RunJobRequest :> Post '[JSON] Job)))))))) Source #

A resource alias for cloudscheduler.projects.locations.jobs.run method which the ProjectsLocationsJobsRun request conforms to.

Creating a Request

projectsLocationsJobsRun Source #

Arguments

:: RunJobRequest	`pPayload`
-> Text	`pName`
-> ProjectsLocationsJobsRun

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

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

data ProjectsLocationsJobsRun Source #

Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

See: projectsLocationsJobsRun smart constructor.

Instances

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

Request Lenses

pXgafv :: Lens' ProjectsLocationsJobsRun (Maybe Xgafv) Source #

V1 error format.

pUploadProtocol :: Lens' ProjectsLocationsJobsRun (Maybe Text) Source #

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

pAccessToken :: Lens' ProjectsLocationsJobsRun (Maybe Text) Source #

OAuth access token.

pUploadType :: Lens' ProjectsLocationsJobsRun (Maybe Text) Source #

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

pPayload :: Lens' ProjectsLocationsJobsRun RunJobRequest Source #

Multipart request metadata.

pName :: Lens' ProjectsLocationsJobsRun Text Source #

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

pCallback :: Lens' ProjectsLocationsJobsRun (Maybe Text) Source #

JSONP