Network.Google.TaskQueue.Types

Service Configuration

taskQueueService :: Service

Default request referring to version v1beta2 of the TaskQueue API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

taskqueueConsumerScope :: OAuthScope

Consume Tasks from your Taskqueues

taskqueueScope :: OAuthScope

Manage your Tasks and Taskqueues

Tasks2

data Tasks2

Instances

Eq Tasks2

Data Tasks2

Show Tasks2

Generic Tasks2

ToJSON Tasks2

FromJSON Tasks2

type Rep Tasks2

tasks2 :: Tasks2

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

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

• tKind
• tItems

tKind :: Lens' Tasks2 Text

The kind of object returned, a list of tasks.

tItems :: Lens' Tasks2 [Task]

The actual list of tasks currently active in the TaskQueue.

TaskQueue

data TaskQueue

Instances

Eq TaskQueue

Data TaskQueue

Show TaskQueue

Generic TaskQueue

ToJSON TaskQueue

FromJSON TaskQueue

type Rep TaskQueue

taskQueue :: TaskQueue

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

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

• tqKind
• tqStats
• tqMaxLeases
• tqId
• tqACL

tqKind :: Lens' TaskQueue Text

The kind of REST object returned, in this case taskqueue.

tqStats :: Lens' TaskQueue (Maybe TaskQueueStats)

Statistics for the TaskQueue object in question.

tqMaxLeases :: Lens' TaskQueue (Maybe Int32)

The number of times we should lease out tasks before giving up on them. If unset we lease them out forever until a worker deletes the task.

tqId :: Lens' TaskQueue (Maybe Text)

Name of the taskqueue.

tqACL :: Lens' TaskQueue (Maybe TaskQueueACL)

ACLs that are applicable to this TaskQueue object.

TaskQueueACL

data TaskQueueACL

ACLs that are applicable to this TaskQueue object.

See: taskQueueACL smart constructor.

Instances

Eq TaskQueueACL

Data TaskQueueACL

Show TaskQueueACL

Generic TaskQueueACL

ToJSON TaskQueueACL

FromJSON TaskQueueACL

type Rep TaskQueueACL

taskQueueACL :: TaskQueueACL

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

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

• tqaProducerEmails
• tqaAdminEmails
• tqaConsumerEmails

tqaProducerEmails :: Lens' TaskQueueACL [Text]

Email addresses of users who can "produce" tasks into the TaskQueue. This means they can Insert tasks into the queue.

tqaAdminEmails :: Lens' TaskQueueACL [Text]

Email addresses of users who are "admins" of the TaskQueue. This means they can control the queue, eg set ACLs for the queue.

tqaConsumerEmails :: Lens' TaskQueueACL [Text]

Email addresses of users who can "consume" tasks from the TaskQueue. This means they can Dequeue and Delete tasks from the queue.

TaskQueueStats

data TaskQueueStats

Statistics for the TaskQueue object in question.

See: taskQueueStats smart constructor.

Instances

Eq TaskQueueStats

Data TaskQueueStats

Show TaskQueueStats

Generic TaskQueueStats

ToJSON TaskQueueStats

FromJSON TaskQueueStats

type Rep TaskQueueStats

taskQueueStats :: TaskQueueStats

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

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

• tqsTotalTasks
• tqsOldestTask
• tqsLeasedLastHour
• tqsLeasedLastMinute

tqsTotalTasks :: Lens' TaskQueueStats (Maybe Int32)

Number of tasks in the queue.

tqsOldestTask :: Lens' TaskQueueStats (Maybe Int64)

The timestamp (in seconds since the epoch) of the oldest unfinished task.

tqsLeasedLastHour :: Lens' TaskQueueStats (Maybe Int64)

Number of tasks leased in the last hour.

tqsLeasedLastMinute :: Lens' TaskQueueStats (Maybe Int64)

Number of tasks leased in the last minute.

Tasks

data Tasks

Instances

Eq Tasks

Data Tasks

Show Tasks

Generic Tasks

ToJSON Tasks

FromJSON Tasks

type Rep Tasks

tasks :: Tasks

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

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

• tasKind
• tasItems

tasKind :: Lens' Tasks Text

The kind of object returned, a list of tasks.

tasItems :: Lens' Tasks [Task]

The actual list of tasks returned as a result of the lease operation.

Task

data Task

Instances

Eq Task

Data Task

Show Task

Generic Task

ToJSON Task

FromJSON Task

type Rep Task

task :: Task

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

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

• ttRetryCount
• ttEnqueueTimestamp
• ttTag
• ttKind
• ttQueueName
• ttPayloadBase64
• ttId
• ttLeaseTimestamp

ttRetryCount :: Lens' Task (Maybe Int32)

The number of leases applied to this task.

ttEnqueueTimestamp :: Lens' Task (Maybe Int64)

Time (in seconds since the epoch) at which the task was enqueued.

ttTag :: Lens' Task (Maybe Text)

Tag for the task, could be used later to lease tasks grouped by a specific tag.

ttKind :: Lens' Task Text

The kind of object returned, in this case set to task.

ttQueueName :: Lens' Task (Maybe Text)

Name of the queue that the task is in.

ttPayloadBase64 :: Lens' Task (Maybe Text)

A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.

ttId :: Lens' Task (Maybe Text)

Name of the task.

ttLeaseTimestamp :: Lens' Task (Maybe Int64)

Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.