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 |
Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.
See: Cloud Tasks API Reference for cloudtasks.projects.locations.queues.tasks.list
.
Synopsis
- type ProjectsLocationsQueuesTasksListResource = "v2beta3" :> (Capture "parent" Text :> ("tasks" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "responseView" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTasksResponse)))))))))))
- projectsLocationsQueuesTasksList :: Text -> ProjectsLocationsQueuesTasksList
- data ProjectsLocationsQueuesTasksList
- plqtlParent :: Lens' ProjectsLocationsQueuesTasksList Text
- plqtlXgafv :: Lens' ProjectsLocationsQueuesTasksList (Maybe Xgafv)
- plqtlUploadProtocol :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text)
- plqtlAccessToken :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text)
- plqtlUploadType :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text)
- plqtlResponseView :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text)
- plqtlPageToken :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text)
- plqtlPageSize :: Lens' ProjectsLocationsQueuesTasksList (Maybe Int32)
- plqtlCallback :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text)
REST Resource
type ProjectsLocationsQueuesTasksListResource = "v2beta3" :> (Capture "parent" Text :> ("tasks" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "responseView" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTasksResponse))))))))))) Source #
A resource alias for cloudtasks.projects.locations.queues.tasks.list
method which the
ProjectsLocationsQueuesTasksList
request conforms to.
Creating a Request
projectsLocationsQueuesTasksList Source #
Creates a value of ProjectsLocationsQueuesTasksList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProjectsLocationsQueuesTasksList Source #
Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.
See: projectsLocationsQueuesTasksList
smart constructor.
Instances
Request Lenses
plqtlParent :: Lens' ProjectsLocationsQueuesTasksList Text Source #
Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
plqtlXgafv :: Lens' ProjectsLocationsQueuesTasksList (Maybe Xgafv) Source #
V1 error format.
plqtlUploadProtocol :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
plqtlAccessToken :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text) Source #
OAuth access token.
plqtlUploadType :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
plqtlResponseView :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text) Source #
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` Google IAM permission on the Task resource.
plqtlPageToken :: Lens' ProjectsLocationsQueuesTasksList (Maybe Text) Source #
A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.
plqtlPageSize :: Lens' ProjectsLocationsQueuesTasksList (Maybe Int32) Source #
Requested page size. Fewer tasks than requested might be returned. The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.