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.CloudTasks.Projects.Locations.Queues.Pause

Contents

REST Resource
Creating a Request
Request Lenses

Description

Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.

See: Cloud Tasks API Reference for cloudtasks.projects.locations.queues.pause.

Synopsis

type ProjectsLocationsQueuesPauseResource = "v2beta3" :> (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] PauseQueueRequest :> Post '[JSON] Queue))))))))
projectsLocationsQueuesPause :: PauseQueueRequest -> Text -> ProjectsLocationsQueuesPause
data ProjectsLocationsQueuesPause
proXgafv :: Lens' ProjectsLocationsQueuesPause (Maybe Xgafv)
proUploadProtocol :: Lens' ProjectsLocationsQueuesPause (Maybe Text)
proAccessToken :: Lens' ProjectsLocationsQueuesPause (Maybe Text)
proUploadType :: Lens' ProjectsLocationsQueuesPause (Maybe Text)
proPayload :: Lens' ProjectsLocationsQueuesPause PauseQueueRequest
proName :: Lens' ProjectsLocationsQueuesPause Text
proCallback :: Lens' ProjectsLocationsQueuesPause (Maybe Text)

REST Resource

type ProjectsLocationsQueuesPauseResource = "v2beta3" :> (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] PauseQueueRequest :> Post '[JSON] Queue)))))))) Source #

A resource alias for cloudtasks.projects.locations.queues.pause method which the ProjectsLocationsQueuesPause request conforms to.

Creating a Request

projectsLocationsQueuesPause Source #

Arguments

:: PauseQueueRequest	`proPayload`
-> Text	`proName`
-> ProjectsLocationsQueuesPause

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

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

data ProjectsLocationsQueuesPause Source #

Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.

See: projectsLocationsQueuesPause smart constructor.

Instances

Eq ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause Methods (==) :: ProjectsLocationsQueuesPause -> ProjectsLocationsQueuesPause -> Bool # (/=) :: ProjectsLocationsQueuesPause -> ProjectsLocationsQueuesPause -> Bool #
Data ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsLocationsQueuesPause -> c ProjectsLocationsQueuesPause # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsLocationsQueuesPause # toConstr :: ProjectsLocationsQueuesPause -> Constr # dataTypeOf :: ProjectsLocationsQueuesPause -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsLocationsQueuesPause) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsLocationsQueuesPause) # gmapT :: (forall b. Data b => b -> b) -> ProjectsLocationsQueuesPause -> ProjectsLocationsQueuesPause # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsQueuesPause -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsQueuesPause -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsLocationsQueuesPause -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsLocationsQueuesPause -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsLocationsQueuesPause -> m ProjectsLocationsQueuesPause # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsQueuesPause -> m ProjectsLocationsQueuesPause # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsQueuesPause -> m ProjectsLocationsQueuesPause #
Show ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause Methods showsPrec :: Int -> ProjectsLocationsQueuesPause -> ShowS # show :: ProjectsLocationsQueuesPause -> String # showList :: [ProjectsLocationsQueuesPause] -> ShowS #
Generic ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause Associated Types type Rep ProjectsLocationsQueuesPause :: Type -> Type # Methods from :: ProjectsLocationsQueuesPause -> Rep ProjectsLocationsQueuesPause x # to :: Rep ProjectsLocationsQueuesPause x -> ProjectsLocationsQueuesPause #
GoogleRequest ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause Associated Types type Rs ProjectsLocationsQueuesPause :: Type # type Scopes ProjectsLocationsQueuesPause :: [Symbol] # Methods requestClient :: ProjectsLocationsQueuesPause -> GClient (Rs ProjectsLocationsQueuesPause) #
type Rep ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause type Rep ProjectsLocationsQueuesPause = D1 (MetaData "ProjectsLocationsQueuesPause" "Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" False) (C1 (MetaCons "ProjectsLocationsQueuesPause'" 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 PauseQueueRequest)) :: (S1 (MetaSel (Just "_proName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_proCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause type Scopes ProjectsLocationsQueuesPause = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ProjectsLocationsQueuesPause Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Pause type Rs ProjectsLocationsQueuesPause = Queue

Request Lenses

proXgafv :: Lens' ProjectsLocationsQueuesPause (Maybe Xgafv) Source #

V1 error format.

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

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

proAccessToken :: Lens' ProjectsLocationsQueuesPause (Maybe Text) Source #

OAuth access token.

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

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

proPayload :: Lens' ProjectsLocationsQueuesPause PauseQueueRequest Source #

Multipart request metadata.

proName :: Lens' ProjectsLocationsQueuesPause Text Source #

Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`

proCallback :: Lens' ProjectsLocationsQueuesPause (Maybe Text) Source #

JSONP