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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.

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

Synopsis

type ProjectsLocationsQueuesTasksRunResource = "v2beta3" :> (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] RunTaskRequest :> Post '[JSON] Task))))))))
projectsLocationsQueuesTasksRun :: RunTaskRequest -> Text -> ProjectsLocationsQueuesTasksRun
data ProjectsLocationsQueuesTasksRun
plqtrXgafv :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Xgafv)
plqtrUploadProtocol :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text)
plqtrAccessToken :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text)
plqtrUploadType :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text)
plqtrPayload :: Lens' ProjectsLocationsQueuesTasksRun RunTaskRequest
plqtrName :: Lens' ProjectsLocationsQueuesTasksRun Text
plqtrCallback :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text)

REST Resource

type ProjectsLocationsQueuesTasksRunResource = "v2beta3" :> (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] RunTaskRequest :> Post '[JSON] Task)))))))) Source #

A resource alias for cloudtasks.projects.locations.queues.tasks.run method which the ProjectsLocationsQueuesTasksRun request conforms to.

Creating a Request

projectsLocationsQueuesTasksRun Source #

Arguments

:: RunTaskRequest	`plqtrPayload`
-> Text	`plqtrName`
-> ProjectsLocationsQueuesTasksRun

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

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

data ProjectsLocationsQueuesTasksRun Source #

Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.

See: projectsLocationsQueuesTasksRun smart constructor.

Instances

Eq ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run Methods (==) :: ProjectsLocationsQueuesTasksRun -> ProjectsLocationsQueuesTasksRun -> Bool # (/=) :: ProjectsLocationsQueuesTasksRun -> ProjectsLocationsQueuesTasksRun -> Bool #
Data ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsLocationsQueuesTasksRun -> c ProjectsLocationsQueuesTasksRun # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsLocationsQueuesTasksRun # toConstr :: ProjectsLocationsQueuesTasksRun -> Constr # dataTypeOf :: ProjectsLocationsQueuesTasksRun -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsLocationsQueuesTasksRun) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsLocationsQueuesTasksRun) # gmapT :: (forall b. Data b => b -> b) -> ProjectsLocationsQueuesTasksRun -> ProjectsLocationsQueuesTasksRun # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsQueuesTasksRun -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsLocationsQueuesTasksRun -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsLocationsQueuesTasksRun -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsLocationsQueuesTasksRun -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsLocationsQueuesTasksRun -> m ProjectsLocationsQueuesTasksRun # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsQueuesTasksRun -> m ProjectsLocationsQueuesTasksRun # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsLocationsQueuesTasksRun -> m ProjectsLocationsQueuesTasksRun #
Show ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run Methods showsPrec :: Int -> ProjectsLocationsQueuesTasksRun -> ShowS # show :: ProjectsLocationsQueuesTasksRun -> String # showList :: [ProjectsLocationsQueuesTasksRun] -> ShowS #
Generic ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run Associated Types type Rep ProjectsLocationsQueuesTasksRun :: Type -> Type # Methods from :: ProjectsLocationsQueuesTasksRun -> Rep ProjectsLocationsQueuesTasksRun x # to :: Rep ProjectsLocationsQueuesTasksRun x -> ProjectsLocationsQueuesTasksRun #
GoogleRequest ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run Associated Types type Rs ProjectsLocationsQueuesTasksRun :: Type # type Scopes ProjectsLocationsQueuesTasksRun :: [Symbol] # Methods requestClient :: ProjectsLocationsQueuesTasksRun -> GClient (Rs ProjectsLocationsQueuesTasksRun) #
type Rep ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run type Rep ProjectsLocationsQueuesTasksRun = D1 (MetaData "ProjectsLocationsQueuesTasksRun" "Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" False) (C1 (MetaCons "ProjectsLocationsQueuesTasksRun'" PrefixI True) ((S1 (MetaSel (Just "_plqtrXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_plqtrUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_plqtrAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_plqtrUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_plqtrPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RunTaskRequest)) :: (S1 (MetaSel (Just "_plqtrName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_plqtrCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run type Scopes ProjectsLocationsQueuesTasksRun = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ProjectsLocationsQueuesTasksRun Source #
Instance details Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Tasks.Run type Rs ProjectsLocationsQueuesTasksRun = Task

Request Lenses

plqtrXgafv :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Xgafv) Source #

V1 error format.

plqtrUploadProtocol :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text) Source #

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

plqtrAccessToken :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text) Source #

OAuth access token.

plqtrUploadType :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text) Source #

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

plqtrPayload :: Lens' ProjectsLocationsQueuesTasksRun RunTaskRequest Source #

Multipart request metadata.

plqtrName :: Lens' ProjectsLocationsQueuesTasksRun Text Source #

Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`

plqtrCallback :: Lens' ProjectsLocationsQueuesTasksRun (Maybe Text) Source #

JSONP