Network.Google.Resource.TaskQueue.Tasks.Lease

Lease 1 or more tasks from a TaskQueue.

See: TaskQueue API Reference for taskqueue.tasks.lease.

REST Resource

type TasksLeaseResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> ("tasks" :> ("lease" :> (QueryParam "numTasks" (Textual Int32) :> (QueryParam "leaseSecs" (Textual Int32) :> (QueryParam "tag" Text :> (QueryParam "groupByTag" Bool :> (QueryParam "alt" AltJSON :> Post '[JSON] Tasks))))))))))))

A resource alias for taskqueue.tasks.lease method which the TasksLease request conforms to.

Creating a Request

tasksLease

Arguments

:: Text

tlTaskQueue

-> Text

tlProject

-> Int32

tlNumTasks

-> Int32

tlLeaseSecs

-> TasksLease

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

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

• tlTaskQueue
• tlTag
• tlProject
• tlNumTasks
• tlLeaseSecs
• tlGroupByTag

data TasksLease

Lease 1 or more tasks from a TaskQueue.

See: tasksLease smart constructor.

Instances

Eq TasksLease

Methods

(==) :: TasksLease -> TasksLease -> Bool

(/=) :: TasksLease -> TasksLease -> Bool

Data TasksLease

Methods

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

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

toConstr :: TasksLease -> Constr

dataTypeOf :: TasksLease -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TasksLease)

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

gmapT :: (forall b. Data b => b -> b) -> TasksLease -> TasksLease

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

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

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

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

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

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

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

Show TasksLease

Methods

showsPrec :: Int -> TasksLease -> ShowS

show :: TasksLease -> String

showList :: [TasksLease] -> ShowS

Generic TasksLease

Associated Types

type Rep TasksLease :: * -> *

Methods

from :: TasksLease -> Rep TasksLease x

to :: Rep TasksLease x -> TasksLease

GoogleRequest TasksLease

Associated Types

type Rs TasksLease :: *

type Scopes TasksLease :: [Symbol]

Methods

requestClient :: TasksLease -> Client (Rs TasksLease)

type Rep TasksLease

type Rep TasksLease = D1 (MetaData "TasksLease" "Network.Google.Resource.TaskQueue.Tasks.Lease" "gogol-taskqueue-0.3.0-De6GncU4nRo3TG29sWTEtK" False) (C1 (MetaCons "TasksLease'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tlTaskQueue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_tlTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tlProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_tlNumTasks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))) ((:*:) (S1 (MetaSel (Just Symbol "_tlLeaseSecs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))) (S1 (MetaSel (Just Symbol "_tlGroupByTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))))

type Scopes TasksLease

type Scopes TasksLease = (:) Symbol "https://www.googleapis.com/auth/taskqueue" ((:) Symbol "https://www.googleapis.com/auth/taskqueue.consumer" ([] Symbol))

type Rs TasksLease

type Rs TasksLease = Tasks

Request Lenses

tlTaskQueue :: Lens' TasksLease Text

The taskqueue to lease a task from.

tlTag :: Lens' TasksLease (Maybe Text)

The tag allowed for tasks in the response. Must only be specified if group_by_tag is true. If group_by_tag is true and tag is not specified the tag will be that of the oldest task by eta, i.e. the first available tag

tlProject :: Lens' TasksLease Text

The project under which the queue lies.

tlNumTasks :: Lens' TasksLease Int32

The number of tasks to lease.

tlLeaseSecs :: Lens' TasksLease Int32

The lease in seconds.

tlGroupByTag :: Lens' TasksLease (Maybe Bool)

When true, all returned tasks will have the same tag