summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/ReportStatus.hs
blob: 214c42f46c6a5fd65407cf0584cb58557cc43d62 (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
{-# 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.WorkItems.ReportStatus
-- 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)
--
-- Reports the status of dataflow WorkItems leased by a worker.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.jobs.workItems.reportStatus@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.WorkItems.ReportStatus
    (
    -- * REST Resource
      ProjectsLocationsJobsWorkItemsReportStatusResource

    -- * Creating a Request
    , projectsLocationsJobsWorkItemsReportStatus
    , ProjectsLocationsJobsWorkItemsReportStatus

    -- * Request Lenses
    , pljwirsXgafv
    , pljwirsJobId
    , pljwirsUploadProtocol
    , pljwirsLocation
    , pljwirsAccessToken
    , pljwirsUploadType
    , pljwirsPayload
    , pljwirsProjectId
    , pljwirsCallback
    ) where

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

-- | A resource alias for @dataflow.projects.locations.jobs.workItems.reportStatus@ method which the
-- 'ProjectsLocationsJobsWorkItemsReportStatus' request conforms to.
type ProjectsLocationsJobsWorkItemsReportStatusResource
     =
     "v1b3" :>
       "projects" :>
         Capture "projectId" Text :>
           "locations" :>
             Capture "location" Text :>
               "jobs" :>
                 Capture "jobId" Text :>
                   "workItems:reportStatus" :>
                     QueryParam "$.xgafv" Xgafv :>
                       QueryParam "upload_protocol" Text :>
                         QueryParam "access_token" Text :>
                           QueryParam "uploadType" Text :>
                             QueryParam "callback" Text :>
                               QueryParam "alt" AltJSON :>
                                 ReqBody '[JSON] ReportWorkItemStatusRequest :>
                                   Post '[JSON] ReportWorkItemStatusResponse

-- | Reports the status of dataflow WorkItems leased by a worker.
--
-- /See:/ 'projectsLocationsJobsWorkItemsReportStatus' smart constructor.
data ProjectsLocationsJobsWorkItemsReportStatus =
  ProjectsLocationsJobsWorkItemsReportStatus'
    { _pljwirsXgafv          :: !(Maybe Xgafv)
    , _pljwirsJobId          :: !Text
    , _pljwirsUploadProtocol :: !(Maybe Text)
    , _pljwirsLocation       :: !Text
    , _pljwirsAccessToken    :: !(Maybe Text)
    , _pljwirsUploadType     :: !(Maybe Text)
    , _pljwirsPayload        :: !ReportWorkItemStatusRequest
    , _pljwirsProjectId      :: !Text
    , _pljwirsCallback       :: !(Maybe Text)
    }
  deriving (Eq, Show, Data, Typeable, Generic)


-- | Creates a value of 'ProjectsLocationsJobsWorkItemsReportStatus' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'pljwirsXgafv'
--
-- * 'pljwirsJobId'
--
-- * 'pljwirsUploadProtocol'
--
-- * 'pljwirsLocation'
--
-- * 'pljwirsAccessToken'
--
-- * 'pljwirsUploadType'
--
-- * 'pljwirsPayload'
--
-- * 'pljwirsProjectId'
--
-- * 'pljwirsCallback'
projectsLocationsJobsWorkItemsReportStatus
    :: Text -- ^ 'pljwirsJobId'
    -> Text -- ^ 'pljwirsLocation'
    -> ReportWorkItemStatusRequest -- ^ 'pljwirsPayload'
    -> Text -- ^ 'pljwirsProjectId'
    -> ProjectsLocationsJobsWorkItemsReportStatus
projectsLocationsJobsWorkItemsReportStatus pPljwirsJobId_ pPljwirsLocation_ pPljwirsPayload_ pPljwirsProjectId_ =
  ProjectsLocationsJobsWorkItemsReportStatus'
    { _pljwirsXgafv = Nothing
    , _pljwirsJobId = pPljwirsJobId_
    , _pljwirsUploadProtocol = Nothing
    , _pljwirsLocation = pPljwirsLocation_
    , _pljwirsAccessToken = Nothing
    , _pljwirsUploadType = Nothing
    , _pljwirsPayload = pPljwirsPayload_
    , _pljwirsProjectId = pPljwirsProjectId_
    , _pljwirsCallback = Nothing
    }


-- | V1 error format.
pljwirsXgafv :: Lens' ProjectsLocationsJobsWorkItemsReportStatus (Maybe Xgafv)
pljwirsXgafv
  = lens _pljwirsXgafv (\ s a -> s{_pljwirsXgafv = a})

-- | The job which the WorkItem is part of.
pljwirsJobId :: Lens' ProjectsLocationsJobsWorkItemsReportStatus Text
pljwirsJobId
  = lens _pljwirsJobId (\ s a -> s{_pljwirsJobId = a})

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

-- | The [regional endpoint]
-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
-- that contains the WorkItem\'s job.
pljwirsLocation :: Lens' ProjectsLocationsJobsWorkItemsReportStatus Text
pljwirsLocation
  = lens _pljwirsLocation
      (\ s a -> s{_pljwirsLocation = a})

-- | OAuth access token.
pljwirsAccessToken :: Lens' ProjectsLocationsJobsWorkItemsReportStatus (Maybe Text)
pljwirsAccessToken
  = lens _pljwirsAccessToken
      (\ s a -> s{_pljwirsAccessToken = a})

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

-- | Multipart request metadata.
pljwirsPayload :: Lens' ProjectsLocationsJobsWorkItemsReportStatus ReportWorkItemStatusRequest
pljwirsPayload
  = lens _pljwirsPayload
      (\ s a -> s{_pljwirsPayload = a})

-- | The project which owns the WorkItem\'s job.
pljwirsProjectId :: Lens' ProjectsLocationsJobsWorkItemsReportStatus Text
pljwirsProjectId
  = lens _pljwirsProjectId
      (\ s a -> s{_pljwirsProjectId = a})

-- | JSONP
pljwirsCallback :: Lens' ProjectsLocationsJobsWorkItemsReportStatus (Maybe Text)
pljwirsCallback
  = lens _pljwirsCallback
      (\ s a -> s{_pljwirsCallback = a})

instance GoogleRequest
           ProjectsLocationsJobsWorkItemsReportStatus
         where
        type Rs ProjectsLocationsJobsWorkItemsReportStatus =
             ReportWorkItemStatusResponse
        type Scopes
               ProjectsLocationsJobsWorkItemsReportStatus
             =
             '["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
          ProjectsLocationsJobsWorkItemsReportStatus'{..}
          = go _pljwirsProjectId _pljwirsLocation _pljwirsJobId
              _pljwirsXgafv
              _pljwirsUploadProtocol
              _pljwirsAccessToken
              _pljwirsUploadType
              _pljwirsCallback
              (Just AltJSON)
              _pljwirsPayload
              dataflowService
          where go
                  = buildClient
                      (Proxy ::
                         Proxy
                           ProjectsLocationsJobsWorkItemsReportStatusResource)
                      mempty