summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Messages/List.hs
blob: fb1175f9c0c89e87b0892f6e81a5aadb1eb93d9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
{-# LANGUAGE DataKinds          #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric      #-}
{-# LANGUAGE FlexibleInstances  #-}
{-# LANGUAGE NoImplicitPrelude  #-}
{-# LANGUAGE OverloadedStrings  #-}
{-# LANGUAGE RecordWildCards    #-}
{-# LANGUAGE TypeFamilies       #-}
{-# LANGUAGE TypeOperators      #-}

{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds      #-}
{-# OPTIONS_GHC -fno-warn-unused-imports    #-}

-- |
-- Module      : Network.Google.Resource.Dataflow.Projects.Locations.Jobs.Messages.List
-- 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)
--
-- Request the job status. To request the status of a job, we recommend
-- using \`projects.locations.jobs.messages.list\` with a [regional
-- endpoint]
-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
-- Using \`projects.jobs.messages.list\` is not recommended, as you can
-- only request the status of jobs that are running in \`us-central1\`.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.jobs.messages.list@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.Messages.List
    (
    -- * REST Resource
      ProjectsLocationsJobsMessagesListResource

    -- * Creating a Request
    , projectsLocationsJobsMessagesList
    , ProjectsLocationsJobsMessagesList

    -- * Request Lenses
    , pljmlXgafv
    , pljmlJobId
    , pljmlUploadProtocol
    , pljmlLocation
    , pljmlStartTime
    , pljmlAccessToken
    , pljmlUploadType
    , pljmlEndTime
    , pljmlMinimumImportance
    , pljmlPageToken
    , pljmlProjectId
    , pljmlPageSize
    , pljmlCallback
    ) where

import           Network.Google.Dataflow.Types
import           Network.Google.Prelude

-- | A resource alias for @dataflow.projects.locations.jobs.messages.list@ method which the
-- 'ProjectsLocationsJobsMessagesList' request conforms to.
type ProjectsLocationsJobsMessagesListResource =
     "v1b3" :>
       "projects" :>
         Capture "projectId" Text :>
           "locations" :>
             Capture "location" Text :>
               "jobs" :>
                 Capture "jobId" Text :>
                   "messages" :>
                     QueryParam "$.xgafv" Xgafv :>
                       QueryParam "upload_protocol" Text :>
                         QueryParam "startTime" DateTime' :>
                           QueryParam "access_token" Text :>
                             QueryParam "uploadType" Text :>
                               QueryParam "endTime" DateTime' :>
                                 QueryParam "minimumImportance" Text :>
                                   QueryParam "pageToken" Text :>
                                     QueryParam "pageSize" (Textual Int32) :>
                                       QueryParam "callback" Text :>
                                         QueryParam "alt" AltJSON :>
                                           Get '[JSON] ListJobMessagesResponse

-- | Request the job status. To request the status of a job, we recommend
-- using \`projects.locations.jobs.messages.list\` with a [regional
-- endpoint]
-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
-- Using \`projects.jobs.messages.list\` is not recommended, as you can
-- only request the status of jobs that are running in \`us-central1\`.
--
-- /See:/ 'projectsLocationsJobsMessagesList' smart constructor.
data ProjectsLocationsJobsMessagesList =
  ProjectsLocationsJobsMessagesList'
    { _pljmlXgafv             :: !(Maybe Xgafv)
    , _pljmlJobId             :: !Text
    , _pljmlUploadProtocol    :: !(Maybe Text)
    , _pljmlLocation          :: !Text
    , _pljmlStartTime         :: !(Maybe DateTime')
    , _pljmlAccessToken       :: !(Maybe Text)
    , _pljmlUploadType        :: !(Maybe Text)
    , _pljmlEndTime           :: !(Maybe DateTime')
    , _pljmlMinimumImportance :: !(Maybe Text)
    , _pljmlPageToken         :: !(Maybe Text)
    , _pljmlProjectId         :: !Text
    , _pljmlPageSize          :: !(Maybe (Textual Int32))
    , _pljmlCallback          :: !(Maybe Text)
    }
  deriving (Eq, Show, Data, Typeable, Generic)


-- | Creates a value of 'ProjectsLocationsJobsMessagesList' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'pljmlXgafv'
--
-- * 'pljmlJobId'
--
-- * 'pljmlUploadProtocol'
--
-- * 'pljmlLocation'
--
-- * 'pljmlStartTime'
--
-- * 'pljmlAccessToken'
--
-- * 'pljmlUploadType'
--
-- * 'pljmlEndTime'
--
-- * 'pljmlMinimumImportance'
--
-- * 'pljmlPageToken'
--
-- * 'pljmlProjectId'
--
-- * 'pljmlPageSize'
--
-- * 'pljmlCallback'
projectsLocationsJobsMessagesList
    :: Text -- ^ 'pljmlJobId'
    -> Text -- ^ 'pljmlLocation'
    -> Text -- ^ 'pljmlProjectId'
    -> ProjectsLocationsJobsMessagesList
projectsLocationsJobsMessagesList pPljmlJobId_ pPljmlLocation_ pPljmlProjectId_ =
  ProjectsLocationsJobsMessagesList'
    { _pljmlXgafv = Nothing
    , _pljmlJobId = pPljmlJobId_
    , _pljmlUploadProtocol = Nothing
    , _pljmlLocation = pPljmlLocation_
    , _pljmlStartTime = Nothing
    , _pljmlAccessToken = Nothing
    , _pljmlUploadType = Nothing
    , _pljmlEndTime = Nothing
    , _pljmlMinimumImportance = Nothing
    , _pljmlPageToken = Nothing
    , _pljmlProjectId = pPljmlProjectId_
    , _pljmlPageSize = Nothing
    , _pljmlCallback = Nothing
    }


-- | V1 error format.
pljmlXgafv :: Lens' ProjectsLocationsJobsMessagesList (Maybe Xgafv)
pljmlXgafv
  = lens _pljmlXgafv (\ s a -> s{_pljmlXgafv = a})

-- | The job to get messages about.
pljmlJobId :: Lens' ProjectsLocationsJobsMessagesList Text
pljmlJobId
  = lens _pljmlJobId (\ s a -> s{_pljmlJobId = a})

-- | Upload protocol for media (e.g. \"raw\", \"multipart\").
pljmlUploadProtocol :: Lens' ProjectsLocationsJobsMessagesList (Maybe Text)
pljmlUploadProtocol
  = lens _pljmlUploadProtocol
      (\ s a -> s{_pljmlUploadProtocol = a})

-- | The [regional endpoint]
-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
-- that contains the job specified by job_id.
pljmlLocation :: Lens' ProjectsLocationsJobsMessagesList Text
pljmlLocation
  = lens _pljmlLocation
      (\ s a -> s{_pljmlLocation = a})

-- | If specified, return only messages with timestamps >= start_time. The
-- default is the job creation time (i.e. beginning of messages).
pljmlStartTime :: Lens' ProjectsLocationsJobsMessagesList (Maybe UTCTime)
pljmlStartTime
  = lens _pljmlStartTime
      (\ s a -> s{_pljmlStartTime = a})
      . mapping _DateTime

-- | OAuth access token.
pljmlAccessToken :: Lens' ProjectsLocationsJobsMessagesList (Maybe Text)
pljmlAccessToken
  = lens _pljmlAccessToken
      (\ s a -> s{_pljmlAccessToken = a})

-- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
pljmlUploadType :: Lens' ProjectsLocationsJobsMessagesList (Maybe Text)
pljmlUploadType
  = lens _pljmlUploadType
      (\ s a -> s{_pljmlUploadType = a})

-- | Return only messages with timestamps \< end_time. The default is now
-- (i.e. return up to the latest messages available).
pljmlEndTime :: Lens' ProjectsLocationsJobsMessagesList (Maybe UTCTime)
pljmlEndTime
  = lens _pljmlEndTime (\ s a -> s{_pljmlEndTime = a})
      . mapping _DateTime

-- | Filter to only get messages with importance >= level
pljmlMinimumImportance :: Lens' ProjectsLocationsJobsMessagesList (Maybe Text)
pljmlMinimumImportance
  = lens _pljmlMinimumImportance
      (\ s a -> s{_pljmlMinimumImportance = a})

-- | If supplied, this should be the value of next_page_token returned by an
-- earlier call. This will cause the next page of results to be returned.
pljmlPageToken :: Lens' ProjectsLocationsJobsMessagesList (Maybe Text)
pljmlPageToken
  = lens _pljmlPageToken
      (\ s a -> s{_pljmlPageToken = a})

-- | A project id.
pljmlProjectId :: Lens' ProjectsLocationsJobsMessagesList Text
pljmlProjectId
  = lens _pljmlProjectId
      (\ s a -> s{_pljmlProjectId = a})

-- | If specified, determines the maximum number of messages to return. If
-- unspecified, the service may choose an appropriate default, or may
-- return an arbitrarily large number of results.
pljmlPageSize :: Lens' ProjectsLocationsJobsMessagesList (Maybe Int32)
pljmlPageSize
  = lens _pljmlPageSize
      (\ s a -> s{_pljmlPageSize = a})
      . mapping _Coerce

-- | JSONP
pljmlCallback :: Lens' ProjectsLocationsJobsMessagesList (Maybe Text)
pljmlCallback
  = lens _pljmlCallback
      (\ s a -> s{_pljmlCallback = a})

instance GoogleRequest
           ProjectsLocationsJobsMessagesList
         where
        type Rs ProjectsLocationsJobsMessagesList =
             ListJobMessagesResponse
        type Scopes ProjectsLocationsJobsMessagesList =
             '["https://www.googleapis.com/auth/cloud-platform",
               "https://www.googleapis.com/auth/compute",
               "https://www.googleapis.com/auth/compute.readonly",
               "https://www.googleapis.com/auth/userinfo.email"]
        requestClient ProjectsLocationsJobsMessagesList'{..}
          = go _pljmlProjectId _pljmlLocation _pljmlJobId
              _pljmlXgafv
              _pljmlUploadProtocol
              _pljmlStartTime
              _pljmlAccessToken
              _pljmlUploadType
              _pljmlEndTime
              _pljmlMinimumImportance
              _pljmlPageToken
              _pljmlPageSize
              _pljmlCallback
              (Just AltJSON)
              dataflowService
          where go
                  = buildClient
                      (Proxy ::
                         Proxy ProjectsLocationsJobsMessagesListResource)
                      mempty