summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs
blob: 2ed39cc205504948fd82f6db7667b8cf73325b19 (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
{-# 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.Jobs.Get
-- 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)
--
-- Gets the state of the specified Cloud Dataflow job.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.jobs.get@.
module Network.Google.Resource.Dataflow.Projects.Jobs.Get
    (
    -- * REST Resource
      ProjectsJobsGetResource

    -- * Creating a Request
    , projectsJobsGet
    , ProjectsJobsGet

    -- * Request Lenses
    , pjgXgafv
    , pjgJobId
    , pjgUploadProtocol
    , pjgLocation
    , pjgAccessToken
    , pjgUploadType
    , pjgView
    , pjgProjectId
    , pjgCallback
    ) where

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

-- | A resource alias for @dataflow.projects.jobs.get@ method which the
-- 'ProjectsJobsGet' request conforms to.
type ProjectsJobsGetResource =
     "v1b3" :>
       "projects" :>
         Capture "projectId" Text :>
           "jobs" :>
             Capture "jobId" Text :>
               QueryParam "$.xgafv" Xgafv :>
                 QueryParam "upload_protocol" Text :>
                   QueryParam "location" Text :>
                     QueryParam "access_token" Text :>
                       QueryParam "uploadType" Text :>
                         QueryParam "view" Text :>
                           QueryParam "callback" Text :>
                             QueryParam "alt" AltJSON :> Get '[JSON] Job

-- | Gets the state of the specified Cloud Dataflow job.
--
-- /See:/ 'projectsJobsGet' smart constructor.
data ProjectsJobsGet = ProjectsJobsGet'
    { _pjgXgafv          :: !(Maybe Xgafv)
    , _pjgJobId          :: !Text
    , _pjgUploadProtocol :: !(Maybe Text)
    , _pjgLocation       :: !(Maybe Text)
    , _pjgAccessToken    :: !(Maybe Text)
    , _pjgUploadType     :: !(Maybe Text)
    , _pjgView           :: !(Maybe Text)
    , _pjgProjectId      :: !Text
    , _pjgCallback       :: !(Maybe Text)
    } deriving (Eq,Show,Data,Typeable,Generic)

-- | Creates a value of 'ProjectsJobsGet' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'pjgXgafv'
--
-- * 'pjgJobId'
--
-- * 'pjgUploadProtocol'
--
-- * 'pjgLocation'
--
-- * 'pjgAccessToken'
--
-- * 'pjgUploadType'
--
-- * 'pjgView'
--
-- * 'pjgProjectId'
--
-- * 'pjgCallback'
projectsJobsGet
    :: Text -- ^ 'pjgJobId'
    -> Text -- ^ 'pjgProjectId'
    -> ProjectsJobsGet
projectsJobsGet pPjgJobId_ pPjgProjectId_ =
    ProjectsJobsGet'
    { _pjgXgafv = Nothing
    , _pjgJobId = pPjgJobId_
    , _pjgUploadProtocol = Nothing
    , _pjgLocation = Nothing
    , _pjgAccessToken = Nothing
    , _pjgUploadType = Nothing
    , _pjgView = Nothing
    , _pjgProjectId = pPjgProjectId_
    , _pjgCallback = Nothing
    }

-- | V1 error format.
pjgXgafv :: Lens' ProjectsJobsGet (Maybe Xgafv)
pjgXgafv = lens _pjgXgafv (\ s a -> s{_pjgXgafv = a})

-- | The job ID.
pjgJobId :: Lens' ProjectsJobsGet Text
pjgJobId = lens _pjgJobId (\ s a -> s{_pjgJobId = a})

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

-- | The location that contains this job.
pjgLocation :: Lens' ProjectsJobsGet (Maybe Text)
pjgLocation
  = lens _pjgLocation (\ s a -> s{_pjgLocation = a})

-- | OAuth access token.
pjgAccessToken :: Lens' ProjectsJobsGet (Maybe Text)
pjgAccessToken
  = lens _pjgAccessToken
      (\ s a -> s{_pjgAccessToken = a})

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

-- | The level of information requested in response.
pjgView :: Lens' ProjectsJobsGet (Maybe Text)
pjgView = lens _pjgView (\ s a -> s{_pjgView = a})

-- | The ID of the Cloud Platform project that the job belongs to.
pjgProjectId :: Lens' ProjectsJobsGet Text
pjgProjectId
  = lens _pjgProjectId (\ s a -> s{_pjgProjectId = a})

-- | JSONP
pjgCallback :: Lens' ProjectsJobsGet (Maybe Text)
pjgCallback
  = lens _pjgCallback (\ s a -> s{_pjgCallback = a})

instance GoogleRequest ProjectsJobsGet where
        type Rs ProjectsJobsGet = Job
        type Scopes ProjectsJobsGet =
             '["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 ProjectsJobsGet'{..}
          = go _pjgProjectId _pjgJobId _pjgXgafv
              _pjgUploadProtocol
              _pjgLocation
              _pjgAccessToken
              _pjgUploadType
              _pjgView
              _pjgCallback
              (Just AltJSON)
              dataflowService
          where go
                  = buildClient
                      (Proxy :: Proxy ProjectsJobsGetResource)
                      mempty