-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Google TaskQueue SDK.
--
-- Lets you access a Google App Engine Pull Task Queue over REST.
--
-- Warning: This is an experimental prototype/preview release
-- which is still under exploratory development and not intended for
-- public use, caveat emptor!
--
-- This library is compatible with version v1beta2 of the API.
@package gogol-taskqueue
@version 0.0.1
module Network.Google.TaskQueue.Types
-- | 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.
taskQueueService :: Service
-- | Consume Tasks from your Taskqueues
taskqueueConsumerScope :: OAuthScope
-- | Manage your Tasks and Taskqueues
taskqueueScope :: OAuthScope
data 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:
--
--
tasks2 :: Tasks2
-- | The kind of object returned, a list of tasks.
tKind :: Lens' Tasks2 Text
-- | The actual list of tasks currently active in the TaskQueue.
tItems :: Lens' Tasks2 [Task]
data 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:
--
--
taskQueue :: TaskQueue
-- | The kind of REST object returned, in this case taskqueue.
tqKind :: Lens' TaskQueue Text
-- | Statistics for the TaskQueue object in question.
tqStats :: Lens' TaskQueue (Maybe TaskQueueStats)
-- | 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.
tqMaxLeases :: Lens' TaskQueue (Maybe Int32)
-- | Name of the taskqueue.
tqId :: Lens' TaskQueue (Maybe Text)
-- | ACLs that are applicable to this TaskQueue object.
tqACL :: Lens' TaskQueue (Maybe TaskQueueACL)
-- | ACLs that are applicable to this TaskQueue object.
--
-- See: taskQueueACL smart constructor.
data 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:
--
--
taskQueueACL :: TaskQueueACL
-- | Email addresses of users who can "produce" tasks into the TaskQueue.
-- This means they can Insert tasks into the queue.
tqaProducerEmails :: 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.
tqaAdminEmails :: 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.
tqaConsumerEmails :: Lens' TaskQueueACL [Text]
-- | Statistics for the TaskQueue object in question.
--
-- See: taskQueueStats smart constructor.
data 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:
--
--
taskQueueStats :: TaskQueueStats
-- | Number of tasks in the queue.
tqsTotalTasks :: Lens' TaskQueueStats (Maybe Int32)
-- | The timestamp (in seconds since the epoch) of the oldest unfinished
-- task.
tqsOldestTask :: Lens' TaskQueueStats (Maybe Int64)
-- | Number of tasks leased in the last hour.
tqsLeasedLastHour :: Lens' TaskQueueStats (Maybe Int64)
-- | Number of tasks leased in the last minute.
tqsLeasedLastMinute :: Lens' TaskQueueStats (Maybe Int64)
data 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:
--
--
tasks :: Tasks
-- | The kind of object returned, a list of tasks.
tasKind :: Lens' Tasks Text
-- | The actual list of tasks returned as a result of the lease operation.
tasItems :: Lens' Tasks [Task]
data 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:
--
--
task :: Task
-- | The number of leases applied to this task.
ttRetryCount :: Lens' Task (Maybe Int32)
-- | Time (in seconds since the epoch) at which the task was enqueued.
ttEnqueueTimestamp :: Lens' Task (Maybe Int64)
-- | Tag for the task, could be used later to lease tasks grouped by a
-- specific tag.
ttTag :: Lens' Task (Maybe Text)
-- | The kind of object returned, in this case set to task.
ttKind :: Lens' Task Text
-- | Name of the queue that the task is in.
ttQueueName :: Lens' Task (Maybe Text)
-- | A bag of bytes which is the task payload. The payload on the JSON side
-- is always Base64 encoded.
ttPayloadBase64 :: Lens' Task (Maybe Text)
-- | Name of the task.
ttId :: Lens' Task (Maybe Text)
-- | 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.
ttLeaseTimestamp :: Lens' Task (Maybe Int64)
-- | Delete a task from a TaskQueue.
--
-- See: TaskQueue API Reference for
-- taskqueue.tasks.delete.
module Network.Google.Resource.TaskQueue.Tasks.Delete
-- | A resource alias for taskqueue.tasks.delete method which the
-- TasksDelete request conforms to.
type TasksDeleteResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> ("tasks" :> (Capture "task" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] ()))))))))
-- | Creates a value of TasksDelete with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
tasksDelete :: Text -> Text -> Text -> TasksDelete
-- | Delete a task from a TaskQueue.
--
-- See: tasksDelete smart constructor.
data TasksDelete
-- | The taskqueue to delete a task from.
tdTaskqueue :: Lens' TasksDelete Text
-- | The project under which the queue lies.
tdProject :: Lens' TasksDelete Text
-- | The id of the task to delete.
tdTask :: Lens' TasksDelete Text
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Delete.S1_0_2TasksDelete
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Delete.S1_0_1TasksDelete
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Delete.S1_0_0TasksDelete
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Tasks.Delete.C1_0TasksDelete
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Tasks.Delete.D1TasksDelete
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Tasks.Delete.TasksDelete
instance Data.Data.Data Network.Google.Resource.TaskQueue.Tasks.Delete.TasksDelete
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Tasks.Delete.TasksDelete
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Tasks.Delete.TasksDelete
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Tasks.Delete.TasksDelete
-- | Get a particular task from a TaskQueue.
--
-- See: TaskQueue API Reference for
-- taskqueue.tasks.get.
module Network.Google.Resource.TaskQueue.Tasks.Get
-- | A resource alias for taskqueue.tasks.get method which the
-- TasksGet request conforms to.
type TasksGetResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> ("tasks" :> (Capture "task" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Task))))))))
-- | Creates a value of TasksGet with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
tasksGet :: Text -> Text -> Text -> TasksGet
-- | Get a particular task from a TaskQueue.
--
-- See: tasksGet smart constructor.
data TasksGet
-- | The taskqueue in which the task belongs.
tgTaskqueue :: Lens' TasksGet Text
-- | The project under which the queue lies.
tgProject :: Lens' TasksGet Text
-- | The task to get properties of.
tgTask :: Lens' TasksGet Text
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Get.S1_0_2TasksGet
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Get.S1_0_1TasksGet
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Get.S1_0_0TasksGet
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Tasks.Get.C1_0TasksGet
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Tasks.Get.D1TasksGet
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Tasks.Get.TasksGet
instance Data.Data.Data Network.Google.Resource.TaskQueue.Tasks.Get.TasksGet
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Tasks.Get.TasksGet
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Tasks.Get.TasksGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Tasks.Get.TasksGet
-- | Insert a new task in a TaskQueue
--
-- See: TaskQueue API Reference for
-- taskqueue.tasks.insert.
module Network.Google.Resource.TaskQueue.Tasks.Insert
-- | A resource alias for taskqueue.tasks.insert method which the
-- TasksInsert request conforms to.
type TasksInsertResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> ("tasks" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Task :> Post '[JSON] Task))))))))
-- | Creates a value of TasksInsert with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
tasksInsert :: Text -> Text -> Task -> TasksInsert
-- | Insert a new task in a TaskQueue
--
-- See: tasksInsert smart constructor.
data TasksInsert
-- | The taskqueue to insert the task into
tiTaskqueue :: Lens' TasksInsert Text
-- | The project under which the queue lies
tiProject :: Lens' TasksInsert Text
-- | Multipart request metadata.
tiPayload :: Lens' TasksInsert Task
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Insert.S1_0_2TasksInsert
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Insert.S1_0_1TasksInsert
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Insert.S1_0_0TasksInsert
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Tasks.Insert.C1_0TasksInsert
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Tasks.Insert.D1TasksInsert
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Tasks.Insert.TasksInsert
instance Data.Data.Data Network.Google.Resource.TaskQueue.Tasks.Insert.TasksInsert
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Tasks.Insert.TasksInsert
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Tasks.Insert.TasksInsert
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Tasks.Insert.TasksInsert
-- | Lease 1 or more tasks from a TaskQueue.
--
-- See: TaskQueue API Reference for
-- taskqueue.tasks.lease.
module Network.Google.Resource.TaskQueue.Tasks.Lease
-- | A resource alias for taskqueue.tasks.lease method which the
-- TasksLease request conforms to.
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))))))))))))
-- | 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:
--
--
tasksLease :: Text -> Text -> Int32 -> Int32 -> TasksLease
-- | Lease 1 or more tasks from a TaskQueue.
--
-- See: tasksLease smart constructor.
data TasksLease
-- | The taskqueue to lease a task from.
tlTaskqueue :: Lens' TasksLease 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
tlTag :: Lens' TasksLease (Maybe Text)
-- | The project under which the queue lies.
tlProject :: Lens' TasksLease Text
-- | The number of tasks to lease.
tlNumTasks :: Lens' TasksLease Int32
-- | The lease in seconds.
tlLeaseSecs :: Lens' TasksLease Int32
-- | When true, all returned tasks will have the same tag
tlGroupByTag :: Lens' TasksLease (Maybe Bool)
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Lease.S1_0_5TasksLease
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Lease.S1_0_4TasksLease
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Lease.S1_0_3TasksLease
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Lease.S1_0_2TasksLease
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Lease.S1_0_1TasksLease
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Lease.S1_0_0TasksLease
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Tasks.Lease.C1_0TasksLease
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Tasks.Lease.D1TasksLease
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Tasks.Lease.TasksLease
instance Data.Data.Data Network.Google.Resource.TaskQueue.Tasks.Lease.TasksLease
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Tasks.Lease.TasksLease
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Tasks.Lease.TasksLease
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Tasks.Lease.TasksLease
-- | List Tasks in a TaskQueue
--
-- See: TaskQueue API Reference for
-- taskqueue.tasks.list.
module Network.Google.Resource.TaskQueue.Tasks.List
-- | A resource alias for taskqueue.tasks.list method which the
-- TasksList request conforms to.
type TasksListResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> ("tasks" :> (QueryParam "alt" AltJSON :> Get '[JSON] Tasks2)))))))
-- | Creates a value of TasksList with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
tasksList :: Text -> Text -> TasksList
-- | List Tasks in a TaskQueue
--
-- See: tasksList smart constructor.
data TasksList
-- | The id of the taskqueue to list tasks from.
tTaskqueue :: Lens' TasksList Text
-- | The project under which the queue lies.
tProject :: Lens' TasksList Text
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.List.S1_0_1TasksList
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.List.S1_0_0TasksList
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Tasks.List.C1_0TasksList
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Tasks.List.D1TasksList
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Tasks.List.TasksList
instance Data.Data.Data Network.Google.Resource.TaskQueue.Tasks.List.TasksList
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Tasks.List.TasksList
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Tasks.List.TasksList
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Tasks.List.TasksList
-- | Update tasks that are leased out of a TaskQueue. This method supports
-- patch semantics.
--
-- See: TaskQueue API Reference for
-- taskqueue.tasks.patch.
module Network.Google.Resource.TaskQueue.Tasks.Patch
-- | A resource alias for taskqueue.tasks.patch method which the
-- TasksPatch request conforms to.
type TasksPatchResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> ("tasks" :> (Capture "task" Text :> (QueryParam "newLeaseSeconds" (Textual Int32) :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Task :> Patch '[JSON] Task))))))))))
-- | Creates a value of TasksPatch with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
tasksPatch :: Text -> Text -> Task -> Text -> Int32 -> TasksPatch
-- | Update tasks that are leased out of a TaskQueue. This method supports
-- patch semantics.
--
-- See: tasksPatch smart constructor.
data TasksPatch
tpTaskqueue :: Lens' TasksPatch Text
-- | The project under which the queue lies.
tpProject :: Lens' TasksPatch Text
-- | Multipart request metadata.
tpPayload :: Lens' TasksPatch Task
tpTask :: Lens' TasksPatch Text
-- | The new lease in seconds.
tpNewLeaseSeconds :: Lens' TasksPatch Int32
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Patch.S1_0_4TasksPatch
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Patch.S1_0_3TasksPatch
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Patch.S1_0_2TasksPatch
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Patch.S1_0_1TasksPatch
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Patch.S1_0_0TasksPatch
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Tasks.Patch.C1_0TasksPatch
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Tasks.Patch.D1TasksPatch
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Tasks.Patch.TasksPatch
instance Data.Data.Data Network.Google.Resource.TaskQueue.Tasks.Patch.TasksPatch
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Tasks.Patch.TasksPatch
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Tasks.Patch.TasksPatch
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Tasks.Patch.TasksPatch
-- | Update tasks that are leased out of a TaskQueue.
--
-- See: TaskQueue API Reference for
-- taskqueue.tasks.update.
module Network.Google.Resource.TaskQueue.Tasks.Update
-- | A resource alias for taskqueue.tasks.update method which the
-- TasksUpdate request conforms to.
type TasksUpdateResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> ("tasks" :> (Capture "task" Text :> (QueryParam "newLeaseSeconds" (Textual Int32) :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Task :> Post '[JSON] Task))))))))))
-- | Creates a value of TasksUpdate with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
tasksUpdate :: Text -> Text -> Task -> Text -> Int32 -> TasksUpdate
-- | Update tasks that are leased out of a TaskQueue.
--
-- See: tasksUpdate smart constructor.
data TasksUpdate
tuTaskqueue :: Lens' TasksUpdate Text
-- | The project under which the queue lies.
tuProject :: Lens' TasksUpdate Text
-- | Multipart request metadata.
tuPayload :: Lens' TasksUpdate Task
tuTask :: Lens' TasksUpdate Text
-- | The new lease in seconds.
tuNewLeaseSeconds :: Lens' TasksUpdate Int32
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Update.S1_0_4TasksUpdate
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Update.S1_0_3TasksUpdate
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Update.S1_0_2TasksUpdate
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Update.S1_0_1TasksUpdate
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Tasks.Update.S1_0_0TasksUpdate
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Tasks.Update.C1_0TasksUpdate
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Tasks.Update.D1TasksUpdate
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Tasks.Update.TasksUpdate
instance Data.Data.Data Network.Google.Resource.TaskQueue.Tasks.Update.TasksUpdate
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Tasks.Update.TasksUpdate
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Tasks.Update.TasksUpdate
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Tasks.Update.TasksUpdate
-- | Get detailed information about a TaskQueue.
--
-- See: TaskQueue API Reference for
-- taskqueue.taskqueues.get.
module Network.Google.Resource.TaskQueue.Taskqueues.Get
-- | A resource alias for taskqueue.taskqueues.get method which
-- the TaskqueuesGet request conforms to.
type TaskqueuesGetResource = "taskqueue" :> ("v1beta2" :> ("projects" :> (Capture "project" Text :> ("taskqueues" :> (Capture "taskqueue" Text :> (QueryParam "getStats" Bool :> (QueryParam "alt" AltJSON :> Get '[JSON] TaskQueue)))))))
-- | Creates a value of TaskqueuesGet with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
taskqueuesGet :: Text -> Text -> TaskqueuesGet
-- | Get detailed information about a TaskQueue.
--
-- See: taskqueuesGet smart constructor.
data TaskqueuesGet
-- | The id of the taskqueue to get the properties of.
tasTaskqueue :: Lens' TaskqueuesGet Text
-- | The project under which the queue lies.
tasProject :: Lens' TaskqueuesGet Text
-- | Whether to get stats. Optional.
tasGetStats :: Lens' TaskqueuesGet (Maybe Bool)
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Taskqueues.Get.S1_0_2TaskqueuesGet
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Taskqueues.Get.S1_0_1TaskqueuesGet
instance GHC.Generics.Selector Network.Google.Resource.TaskQueue.Taskqueues.Get.S1_0_0TaskqueuesGet
instance GHC.Generics.Constructor Network.Google.Resource.TaskQueue.Taskqueues.Get.C1_0TaskqueuesGet
instance GHC.Generics.Datatype Network.Google.Resource.TaskQueue.Taskqueues.Get.D1TaskqueuesGet
instance GHC.Generics.Generic Network.Google.Resource.TaskQueue.Taskqueues.Get.TaskqueuesGet
instance Data.Data.Data Network.Google.Resource.TaskQueue.Taskqueues.Get.TaskqueuesGet
instance GHC.Show.Show Network.Google.Resource.TaskQueue.Taskqueues.Get.TaskqueuesGet
instance GHC.Classes.Eq Network.Google.Resource.TaskQueue.Taskqueues.Get.TaskqueuesGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.TaskQueue.Taskqueues.Get.TaskqueuesGet
-- | Lets you access a Google App Engine Pull Task Queue over REST.
--
-- See: TaskQueue API Reference
module Network.Google.TaskQueue
-- | 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.
taskQueueService :: Service
-- | Represents the entirety of the methods and resources available for the
-- TaskQueue API service.
type TaskQueueAPI = TasksInsertResource :<|> (TasksListResource :<|> (TasksPatchResource :<|> (TasksGetResource :<|> (TasksLeaseResource :<|> (TasksDeleteResource :<|> (TasksUpdateResource :<|> TaskqueuesGetResource))))))
data 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:
--
--
tasks2 :: Tasks2
-- | The kind of object returned, a list of tasks.
tKind :: Lens' Tasks2 Text
-- | The actual list of tasks currently active in the TaskQueue.
tItems :: Lens' Tasks2 [Task]
data 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:
--
--
taskQueue :: TaskQueue
-- | The kind of REST object returned, in this case taskqueue.
tqKind :: Lens' TaskQueue Text
-- | Statistics for the TaskQueue object in question.
tqStats :: Lens' TaskQueue (Maybe TaskQueueStats)
-- | 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.
tqMaxLeases :: Lens' TaskQueue (Maybe Int32)
-- | Name of the taskqueue.
tqId :: Lens' TaskQueue (Maybe Text)
-- | ACLs that are applicable to this TaskQueue object.
tqACL :: Lens' TaskQueue (Maybe TaskQueueACL)
-- | ACLs that are applicable to this TaskQueue object.
--
-- See: taskQueueACL smart constructor.
data 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:
--
--
taskQueueACL :: TaskQueueACL
-- | Email addresses of users who can "produce" tasks into the TaskQueue.
-- This means they can Insert tasks into the queue.
tqaProducerEmails :: 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.
tqaAdminEmails :: 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.
tqaConsumerEmails :: Lens' TaskQueueACL [Text]
-- | Statistics for the TaskQueue object in question.
--
-- See: taskQueueStats smart constructor.
data 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:
--
--
taskQueueStats :: TaskQueueStats
-- | Number of tasks in the queue.
tqsTotalTasks :: Lens' TaskQueueStats (Maybe Int32)
-- | The timestamp (in seconds since the epoch) of the oldest unfinished
-- task.
tqsOldestTask :: Lens' TaskQueueStats (Maybe Int64)
-- | Number of tasks leased in the last hour.
tqsLeasedLastHour :: Lens' TaskQueueStats (Maybe Int64)
-- | Number of tasks leased in the last minute.
tqsLeasedLastMinute :: Lens' TaskQueueStats (Maybe Int64)
data 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:
--
--
tasks :: Tasks
-- | The kind of object returned, a list of tasks.
tasKind :: Lens' Tasks Text
-- | The actual list of tasks returned as a result of the lease operation.
tasItems :: Lens' Tasks [Task]
data 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:
--
--
task :: Task
-- | The number of leases applied to this task.
ttRetryCount :: Lens' Task (Maybe Int32)
-- | Time (in seconds since the epoch) at which the task was enqueued.
ttEnqueueTimestamp :: Lens' Task (Maybe Int64)
-- | Tag for the task, could be used later to lease tasks grouped by a
-- specific tag.
ttTag :: Lens' Task (Maybe Text)
-- | The kind of object returned, in this case set to task.
ttKind :: Lens' Task Text
-- | Name of the queue that the task is in.
ttQueueName :: Lens' Task (Maybe Text)
-- | A bag of bytes which is the task payload. The payload on the JSON side
-- is always Base64 encoded.
ttPayloadBase64 :: Lens' Task (Maybe Text)
-- | Name of the task.
ttId :: Lens' Task (Maybe Text)
-- | 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.
ttLeaseTimestamp :: Lens' Task (Maybe Int64)