summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Locations/Templates/Launch.hs
blob: b37e8bcee7a1478529455316c2457216c6befc2f (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
{-# 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.Templates.Launch
-- 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)
--
-- Launch a template.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.templates.launch@.
module Network.Google.Resource.Dataflow.Projects.Locations.Templates.Launch
    (
    -- * REST Resource
      ProjectsLocationsTemplatesLaunchResource

    -- * Creating a Request
    , projectsLocationsTemplatesLaunch
    , ProjectsLocationsTemplatesLaunch

    -- * Request Lenses
    , pltlXgafv
    , pltlValidateOnly
    , pltlUploadProtocol
    , pltlLocation
    , pltlAccessToken
    , pltlUploadType
    , pltlPayload
    , pltlDynamicTemplateStagingLocation
    , pltlGcsPath
    , pltlProjectId
    , pltlCallback
    , pltlDynamicTemplateGcsPath
    ) where

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

-- | A resource alias for @dataflow.projects.locations.templates.launch@ method which the
-- 'ProjectsLocationsTemplatesLaunch' request conforms to.
type ProjectsLocationsTemplatesLaunchResource =
     "v1b3" :>
       "projects" :>
         Capture "projectId" Text :>
           "locations" :>
             Capture "location" Text :>
               "templates:launch" :>
                 QueryParam "$.xgafv" Xgafv :>
                   QueryParam "validateOnly" Bool :>
                     QueryParam "upload_protocol" Text :>
                       QueryParam "access_token" Text :>
                         QueryParam "uploadType" Text :>
                           QueryParam "dynamicTemplate.stagingLocation" Text :>
                             QueryParam "gcsPath" Text :>
                               QueryParam "callback" Text :>
                                 QueryParam "dynamicTemplate.gcsPath" Text :>
                                   QueryParam "alt" AltJSON :>
                                     ReqBody '[JSON] LaunchTemplateParameters :>
                                       Post '[JSON] LaunchTemplateResponse

-- | Launch a template.
--
-- /See:/ 'projectsLocationsTemplatesLaunch' smart constructor.
data ProjectsLocationsTemplatesLaunch =
  ProjectsLocationsTemplatesLaunch'
    { _pltlXgafv                          :: !(Maybe Xgafv)
    , _pltlValidateOnly                   :: !(Maybe Bool)
    , _pltlUploadProtocol                 :: !(Maybe Text)
    , _pltlLocation                       :: !Text
    , _pltlAccessToken                    :: !(Maybe Text)
    , _pltlUploadType                     :: !(Maybe Text)
    , _pltlPayload                        :: !LaunchTemplateParameters
    , _pltlDynamicTemplateStagingLocation :: !(Maybe Text)
    , _pltlGcsPath                        :: !(Maybe Text)
    , _pltlProjectId                      :: !Text
    , _pltlCallback                       :: !(Maybe Text)
    , _pltlDynamicTemplateGcsPath         :: !(Maybe Text)
    }
  deriving (Eq, Show, Data, Typeable, Generic)


-- | Creates a value of 'ProjectsLocationsTemplatesLaunch' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'pltlXgafv'
--
-- * 'pltlValidateOnly'
--
-- * 'pltlUploadProtocol'
--
-- * 'pltlLocation'
--
-- * 'pltlAccessToken'
--
-- * 'pltlUploadType'
--
-- * 'pltlPayload'
--
-- * 'pltlDynamicTemplateStagingLocation'
--
-- * 'pltlGcsPath'
--
-- * 'pltlProjectId'
--
-- * 'pltlCallback'
--
-- * 'pltlDynamicTemplateGcsPath'
projectsLocationsTemplatesLaunch
    :: Text -- ^ 'pltlLocation'
    -> LaunchTemplateParameters -- ^ 'pltlPayload'
    -> Text -- ^ 'pltlProjectId'
    -> ProjectsLocationsTemplatesLaunch
projectsLocationsTemplatesLaunch pPltlLocation_ pPltlPayload_ pPltlProjectId_ =
  ProjectsLocationsTemplatesLaunch'
    { _pltlXgafv = Nothing
    , _pltlValidateOnly = Nothing
    , _pltlUploadProtocol = Nothing
    , _pltlLocation = pPltlLocation_
    , _pltlAccessToken = Nothing
    , _pltlUploadType = Nothing
    , _pltlPayload = pPltlPayload_
    , _pltlDynamicTemplateStagingLocation = Nothing
    , _pltlGcsPath = Nothing
    , _pltlProjectId = pPltlProjectId_
    , _pltlCallback = Nothing
    , _pltlDynamicTemplateGcsPath = Nothing
    }


-- | V1 error format.
pltlXgafv :: Lens' ProjectsLocationsTemplatesLaunch (Maybe Xgafv)
pltlXgafv
  = lens _pltlXgafv (\ s a -> s{_pltlXgafv = a})

-- | If true, the request is validated but not actually executed. Defaults to
-- false.
pltlValidateOnly :: Lens' ProjectsLocationsTemplatesLaunch (Maybe Bool)
pltlValidateOnly
  = lens _pltlValidateOnly
      (\ s a -> s{_pltlValidateOnly = a})

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

-- | The [regional endpoint]
-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
-- to which to direct the request.
pltlLocation :: Lens' ProjectsLocationsTemplatesLaunch Text
pltlLocation
  = lens _pltlLocation (\ s a -> s{_pltlLocation = a})

-- | OAuth access token.
pltlAccessToken :: Lens' ProjectsLocationsTemplatesLaunch (Maybe Text)
pltlAccessToken
  = lens _pltlAccessToken
      (\ s a -> s{_pltlAccessToken = a})

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

-- | Multipart request metadata.
pltlPayload :: Lens' ProjectsLocationsTemplatesLaunch LaunchTemplateParameters
pltlPayload
  = lens _pltlPayload (\ s a -> s{_pltlPayload = a})

-- | Cloud Storage path for staging dependencies. Must be a valid Cloud
-- Storage URL, beginning with \`gs:\/\/\`.
pltlDynamicTemplateStagingLocation :: Lens' ProjectsLocationsTemplatesLaunch (Maybe Text)
pltlDynamicTemplateStagingLocation
  = lens _pltlDynamicTemplateStagingLocation
      (\ s a -> s{_pltlDynamicTemplateStagingLocation = a})

-- | A Cloud Storage path to the template from which to create the job. Must
-- be valid Cloud Storage URL, beginning with \'gs:\/\/\'.
pltlGcsPath :: Lens' ProjectsLocationsTemplatesLaunch (Maybe Text)
pltlGcsPath
  = lens _pltlGcsPath (\ s a -> s{_pltlGcsPath = a})

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

-- | JSONP
pltlCallback :: Lens' ProjectsLocationsTemplatesLaunch (Maybe Text)
pltlCallback
  = lens _pltlCallback (\ s a -> s{_pltlCallback = a})

-- | Path to dynamic template spec file on GCS. The file must be a Json
-- serialized DynamicTemplateFieSpec object.
pltlDynamicTemplateGcsPath :: Lens' ProjectsLocationsTemplatesLaunch (Maybe Text)
pltlDynamicTemplateGcsPath
  = lens _pltlDynamicTemplateGcsPath
      (\ s a -> s{_pltlDynamicTemplateGcsPath = a})

instance GoogleRequest
           ProjectsLocationsTemplatesLaunch
         where
        type Rs ProjectsLocationsTemplatesLaunch =
             LaunchTemplateResponse
        type Scopes ProjectsLocationsTemplatesLaunch =
             '["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 ProjectsLocationsTemplatesLaunch'{..}
          = go _pltlProjectId _pltlLocation _pltlXgafv
              _pltlValidateOnly
              _pltlUploadProtocol
              _pltlAccessToken
              _pltlUploadType
              _pltlDynamicTemplateStagingLocation
              _pltlGcsPath
              _pltlCallback
              _pltlDynamicTemplateGcsPath
              (Just AltJSON)
              _pltlPayload
              dataflowService
          where go
                  = buildClient
                      (Proxy ::
                         Proxy ProjectsLocationsTemplatesLaunchResource)
                      mempty