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

Data TasksLease

Show TasksLease

Generic TasksLease

GoogleRequest TasksLease

type Rep 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