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 |
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
- 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))))))))
- projectsLocationsJobsPause :: PauseJobRequest -> Text -> ProjectsLocationsJobsPause
- data ProjectsLocationsJobsPause
- proXgafv :: Lens' ProjectsLocationsJobsPause (Maybe Xgafv)
- proUploadProtocol :: Lens' ProjectsLocationsJobsPause (Maybe Text)
- proAccessToken :: Lens' ProjectsLocationsJobsPause (Maybe Text)
- proUploadType :: Lens' ProjectsLocationsJobsPause (Maybe Text)
- proPayload :: Lens' ProjectsLocationsJobsPause PauseJobRequest
- proName :: Lens' ProjectsLocationsJobsPause Text
- proCallback :: Lens' ProjectsLocationsJobsPause (Maybe Text)
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
Request Lenses
proUploadProtocol :: Lens' ProjectsLocationsJobsPause (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
proAccessToken :: Lens' ProjectsLocationsJobsPause (Maybe Text) Source #
OAuth access token.
proUploadType :: Lens' ProjectsLocationsJobsPause (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
proPayload :: Lens' ProjectsLocationsJobsPause PauseJobRequest Source #
Multipart request metadata.
proName :: Lens' ProjectsLocationsJobsPause Text Source #
Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
proCallback :: Lens' ProjectsLocationsJobsPause (Maybe Text) Source #
JSONP