git.iko.soy/gogol
on bec6ff8 help sign in
gogol/gogol-appengine-taskqueue/gen/Network/Google/Resource/Taskqueue/Tasks/Patch.hs
210 lines 6.4 kB history raw
1{-# LANGUAGE DataKinds #-}
2{-# LANGUAGE DeriveDataTypeable #-}
3{-# LANGUAGE DeriveGeneric #-}
4{-# LANGUAGE OverloadedStrings #-}
5{-# LANGUAGE RecordWildCards #-}
6{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeOperators #-}
9{-# OPTIONS_GHC -fno-warn-unused-imports #-}
10{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
12-- |
13-- Module : Network.Google.Resource.Taskqueue.Tasks.Patch
14-- Copyright : (c) 2015 Brendan Hay
15-- License : Mozilla Public License, v. 2.0.
16-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>
17-- Stability : auto-generated
18-- Portability : non-portable (GHC extensions)
19--
20-- | Update tasks that are leased out of a TaskQueue. This method supports
21-- patch semantics.
22--
23-- /See:/ <https://developers.google.com/appengine/docs/python/taskqueue/rest TaskQueue API Reference> for @TaskqueueTasksPatch@.
24module Network.Google.Resource.Taskqueue.Tasks.Patch
25 (
26 -- * REST Resource
27 TasksPatchResource
29 -- * Creating a Request
30 , tasksPatch'
31 , TasksPatch'
33 -- * Request Lenses
34 , tpTaskqueue
35 , tpQuotaUser
36 , tpPrettyPrint
37 , tpProject
38 , tpUserIP
39 , tpKey
40 , tpTask
41 , tpTask
42 , tpOAuthToken
43 , tpNewLeaseSeconds
44 , tpFields
45 ) where
47import Network.Google.AppEngineTaskQueue.Types
48import Network.Google.Prelude
50-- | A resource alias for @TaskqueueTasksPatch@ which the
51-- 'TasksPatch'' request conforms to.
52type TasksPatchResource =
53 Capture "project" Text :>
54 "taskqueues" :>
55 Capture "taskqueue" Text :>
56 "tasks" :>
57 Capture "task" Text :>
58 QueryParam "quotaUser" Text :>
59 QueryParam "prettyPrint" Bool :>
60 QueryParam "userIp" Text :>
61 QueryParam "key" Key :>
62 QueryParam "oauth_token" OAuthToken :>
63 QueryParam "newLeaseSeconds" Int32 :>
64 QueryParam "fields" Text :>
65 QueryParam "alt" AltJSON :>
66 ReqBody '[JSON] Task :> Patch '[JSON] Task
68-- | Update tasks that are leased out of a TaskQueue. This method supports
69-- patch semantics.
70--
71-- /See:/ 'tasksPatch'' smart constructor.
72data TasksPatch' = TasksPatch'
73 { _tpTaskqueue :: !Text
74 , _tpQuotaUser :: !(Maybe Text)
75 , _tpPrettyPrint :: !Bool
76 , _tpProject :: !Text
77 , _tpUserIP :: !(Maybe Text)
78 , _tpKey :: !(Maybe Key)
79 , _tpTask :: !Task
80 , _tpTask :: !Text
81 , _tpOAuthToken :: !(Maybe OAuthToken)
82 , _tpNewLeaseSeconds :: !Int32
83 , _tpFields :: !(Maybe Text)
84 } deriving (Eq,Read,Show,Data,Typeable,Generic)
86-- | Creates a value of 'TasksPatch'' with the minimum fields required to make a request.
87--
88-- Use one of the following lenses to modify other fields as desired:
89--
90-- * 'tpTaskqueue'
91--
92-- * 'tpQuotaUser'
93--
94-- * 'tpPrettyPrint'
95--
96-- * 'tpProject'
97--
98-- * 'tpUserIP'
99--
100-- * 'tpKey'
101--
102-- * 'tpTask'
103--
104-- * 'tpTask'
105--
106-- * 'tpOAuthToken'
107--
108-- * 'tpNewLeaseSeconds'
109--
110-- * 'tpFields'
111tasksPatch'
112 :: Text -- ^ 'taskqueue'
113 -> Text -- ^ 'project'
114 -> Task -- ^ 'Task'
115 -> Text -- ^ 'task'
116 -> Int32 -- ^ 'newLeaseSeconds'
117 -> TasksPatch'
118tasksPatch' pTpTaskqueue_ pTpProject_ pTpTask_ pTpTask_ pTpNewLeaseSeconds_ =
119 TasksPatch'
120 { _tpTaskqueue = pTpTaskqueue_
121 , _tpQuotaUser = Nothing
122 , _tpPrettyPrint = True
123 , _tpProject = pTpProject_
124 , _tpUserIP = Nothing
125 , _tpKey = Nothing
126 , _tpTask = pTpTask_
127 , _tpTask = pTpTask_
128 , _tpOAuthToken = Nothing
129 , _tpNewLeaseSeconds = pTpNewLeaseSeconds_
130 , _tpFields = Nothing
131 }
133tpTaskqueue :: Lens' TasksPatch' Text
134tpTaskqueue
135 = lens _tpTaskqueue (\ s a -> s{_tpTaskqueue = a})
137-- | Available to use for quota purposes for server-side applications. Can be
138-- any arbitrary string assigned to a user, but should not exceed 40
139-- characters. Overrides userIp if both are provided.
140tpQuotaUser :: Lens' TasksPatch' (Maybe Text)
141tpQuotaUser
142 = lens _tpQuotaUser (\ s a -> s{_tpQuotaUser = a})
144-- | Returns response with indentations and line breaks.
145tpPrettyPrint :: Lens' TasksPatch' Bool
146tpPrettyPrint
147 = lens _tpPrettyPrint
148 (\ s a -> s{_tpPrettyPrint = a})
150-- | The project under which the queue lies.
151tpProject :: Lens' TasksPatch' Text
152tpProject
153 = lens _tpProject (\ s a -> s{_tpProject = a})
155-- | IP address of the site where the request originates. Use this if you
156-- want to enforce per-user limits.
157tpUserIP :: Lens' TasksPatch' (Maybe Text)
158tpUserIP = lens _tpUserIP (\ s a -> s{_tpUserIP = a})
160-- | API key. Your API key identifies your project and provides you with API
161-- access, quota, and reports. Required unless you provide an OAuth 2.0
162-- token.
163tpKey :: Lens' TasksPatch' (Maybe Key)
164tpKey = lens _tpKey (\ s a -> s{_tpKey = a})
166-- | Multipart request metadata.
167tpTask :: Lens' TasksPatch' Task
168tpTask = lens _tpTask (\ s a -> s{_tpTask = a})
170tpTask :: Lens' TasksPatch' Text
171tpTask = lens _tpTask (\ s a -> s{_tpTask = a})
173-- | OAuth 2.0 token for the current user.
174tpOAuthToken :: Lens' TasksPatch' (Maybe OAuthToken)
175tpOAuthToken
176 = lens _tpOAuthToken (\ s a -> s{_tpOAuthToken = a})
178-- | The new lease in seconds.
179tpNewLeaseSeconds :: Lens' TasksPatch' Int32
180tpNewLeaseSeconds
181 = lens _tpNewLeaseSeconds
182 (\ s a -> s{_tpNewLeaseSeconds = a})
184-- | Selector specifying which fields to include in a partial response.
185tpFields :: Lens' TasksPatch' (Maybe Text)
186tpFields = lens _tpFields (\ s a -> s{_tpFields = a})
188instance GoogleAuth TasksPatch' where
189 authKey = tpKey . _Just
190 authToken = tpOAuthToken . _Just
192instance GoogleRequest TasksPatch' where
193 type Rs TasksPatch' = Task
194 request
195 = requestWithRoute defReq appEngineTaskQueueURL
196 requestWithRoute r u TasksPatch'{..}
197 = go _tpTaskqueue _tpQuotaUser (Just _tpPrettyPrint)
198 _tpProject
199 _tpUserIP
200 _tpKey
201 _tpTask
202 _tpOAuthToken
203 (Just _tpNewLeaseSeconds)
204 _tpFields
205 (Just AltJSON)
206 _tpTask
207 where go
208 = clientWithRoute (Proxy :: Proxy TasksPatchResource)
209 r
210 u