summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/GetMetrics.hs
blob: 04012b22ab4c2712969af1f5bd536e64efcc79f1 (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
{-# 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.GetMetrics
-- 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.getMetrics\` with a [regional endpoint]
-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
-- Using \`projects.jobs.getMetrics\` 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.getMetrics@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.GetMetrics
    (
    -- * REST Resource
      ProjectsLocationsJobsGetMetricsResource

    -- * Creating a Request
    , projectsLocationsJobsGetMetrics
    , ProjectsLocationsJobsGetMetrics

    -- * Request Lenses
    , pljgmXgafv
    , pljgmJobId
    , pljgmUploadProtocol
    , pljgmLocation
    , pljgmStartTime
    , pljgmAccessToken
    , pljgmUploadType
    , pljgmProjectId
    , pljgmCallback
    ) where

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

-- | A resource alias for @dataflow.projects.locations.jobs.getMetrics@ method which the
-- 'ProjectsLocationsJobsGetMetrics' request conforms to.
type ProjectsLocationsJobsGetMetricsResource =
     "v1b3" :>
       "projects" :>
         Capture "projectId" Text :>
           "locations" :>
             Capture "location" Text :>
               "jobs" :>
                 Capture "jobId" Text :>
                   "metrics" :>
                     QueryParam "$.xgafv" Xgafv :>
                       QueryParam "upload_protocol" Text :>
                         QueryParam "startTime" DateTime' :>
                           QueryParam "access_token" Text :>
                             QueryParam "uploadType" Text :>
                               QueryParam "callback" Text :>
                                 QueryParam "alt" AltJSON :>
                                   Get '[JSON] JobMetrics

-- | Request the job status. To request the status of a job, we recommend
-- using \`projects.locations.jobs.getMetrics\` with a [regional endpoint]
-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
-- Using \`projects.jobs.getMetrics\` is not recommended, as you can only
-- request the status of jobs that are running in \`us-central1\`.
--
-- /See:/ 'projectsLocationsJobsGetMetrics' smart constructor.
data ProjectsLocationsJobsGetMetrics =
  ProjectsLocationsJobsGetMetrics'
    { _pljgmXgafv          :: !(Maybe Xgafv)
    , _pljgmJobId          :: !Text
    , _pljgmUploadProtocol :: !(Maybe Text)
    , _pljgmLocation       :: !Text
    , _pljgmStartTime      :: !(Maybe DateTime')
    , _pljgmAccessToken    :: !(Maybe Text)
    , _pljgmUploadType     :: !(Maybe Text)
    , _pljgmProjectId      :: !Text
    , _pljgmCallback       :: !(Maybe Text)
    }
  deriving (Eq, Show, Data, Typeable, Generic)


-- | Creates a value of 'ProjectsLocationsJobsGetMetrics' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'pljgmXgafv'
--
-- * 'pljgmJobId'
--
-- * 'pljgmUploadProtocol'
--
-- * 'pljgmLocation'
--
-- * 'pljgmStartTime'
--
-- * 'pljgmAccessToken'
--
-- * 'pljgmUploadType'
--
-- * 'pljgmProjectId'
--
-- * 'pljgmCallback'
projectsLocationsJobsGetMetrics
    :: Text -- ^ 'pljgmJobId'
    -> Text -- ^ 'pljgmLocation'
    -> Text -- ^ 'pljgmProjectId'
    -> ProjectsLocationsJobsGetMetrics
projectsLocationsJobsGetMetrics pPljgmJobId_ pPljgmLocation_ pPljgmProjectId_ =
  ProjectsLocationsJobsGetMetrics'
    { _pljgmXgafv = Nothing
    , _pljgmJobId = pPljgmJobId_
    , _pljgmUploadProtocol = Nothing
    , _pljgmLocation = pPljgmLocation_
    , _pljgmStartTime = Nothing
    , _pljgmAccessToken = Nothing
    , _pljgmUploadType = Nothing
    , _pljgmProjectId = pPljgmProjectId_
    , _pljgmCallback = Nothing
    }


-- | V1 error format.
pljgmXgafv :: Lens' ProjectsLocationsJobsGetMetrics (Maybe Xgafv)
pljgmXgafv
  = lens _pljgmXgafv (\ s a -> s{_pljgmXgafv = a})

-- | The job to get messages for.
pljgmJobId :: Lens' ProjectsLocationsJobsGetMetrics Text
pljgmJobId
  = lens _pljgmJobId (\ s a -> s{_pljgmJobId = a})

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

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

-- | Return only metric data that has changed since this time. Default is to
-- return all information about all metrics for the job.
pljgmStartTime :: Lens' ProjectsLocationsJobsGetMetrics (Maybe UTCTime)
pljgmStartTime
  = lens _pljgmStartTime
      (\ s a -> s{_pljgmStartTime = a})
      . mapping _DateTime

-- | OAuth access token.
pljgmAccessToken :: Lens' ProjectsLocationsJobsGetMetrics (Maybe Text)
pljgmAccessToken
  = lens _pljgmAccessToken
      (\ s a -> s{_pljgmAccessToken = a})

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

-- | A project id.
pljgmProjectId :: Lens' ProjectsLocationsJobsGetMetrics Text
pljgmProjectId
  = lens _pljgmProjectId
      (\ s a -> s{_pljgmProjectId = a})

-- | JSONP
pljgmCallback :: Lens' ProjectsLocationsJobsGetMetrics (Maybe Text)
pljgmCallback
  = lens _pljgmCallback
      (\ s a -> s{_pljgmCallback = a})

instance GoogleRequest
           ProjectsLocationsJobsGetMetrics
         where
        type Rs ProjectsLocationsJobsGetMetrics = JobMetrics
        type Scopes ProjectsLocationsJobsGetMetrics =
             '["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 ProjectsLocationsJobsGetMetrics'{..}
          = go _pljgmProjectId _pljgmLocation _pljgmJobId
              _pljgmXgafv
              _pljgmUploadProtocol
              _pljgmStartTime
              _pljgmAccessToken
              _pljgmUploadType
              _pljgmCallback
              (Just AltJSON)
              dataflowService
          where go
                  = buildClient
                      (Proxy ::
                         Proxy ProjectsLocationsJobsGetMetricsResource)
                      mempty