summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Locations/SQL/Validate.hs
blob: da6732c6093b22dfabf342cf7c3f445a6f8e7142 (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
{-# 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.SQL.Validate
-- 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)
--
-- Validates a GoogleSQL query for Cloud Dataflow syntax. Will always
-- confirm the given query parses correctly, and if able to look up schema
-- information from DataCatalog, will validate that the query analyzes
-- properly as well.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.sql.validate@.
module Network.Google.Resource.Dataflow.Projects.Locations.SQL.Validate
    (
    -- * REST Resource
      ProjectsLocationsSQLValidateResource

    -- * Creating a Request
    , projectsLocationsSQLValidate
    , ProjectsLocationsSQLValidate

    -- * Request Lenses
    , plsqlvXgafv
    , plsqlvUploadProtocol
    , plsqlvLocation
    , plsqlvAccessToken
    , plsqlvUploadType
    , plsqlvQuery
    , plsqlvProjectId
    , plsqlvCallback
    ) where

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

-- | A resource alias for @dataflow.projects.locations.sql.validate@ method which the
-- 'ProjectsLocationsSQLValidate' request conforms to.
type ProjectsLocationsSQLValidateResource =
     "v1b3" :>
       "projects" :>
         Capture "projectId" Text :>
           "locations" :>
             Capture "location" Text :>
               "sql:validate" :>
                 QueryParam "$.xgafv" Xgafv :>
                   QueryParam "upload_protocol" Text :>
                     QueryParam "access_token" Text :>
                       QueryParam "uploadType" Text :>
                         QueryParam "query" Text :>
                           QueryParam "callback" Text :>
                             QueryParam "alt" AltJSON :>
                               Get '[JSON] ValidateResponse

-- | Validates a GoogleSQL query for Cloud Dataflow syntax. Will always
-- confirm the given query parses correctly, and if able to look up schema
-- information from DataCatalog, will validate that the query analyzes
-- properly as well.
--
-- /See:/ 'projectsLocationsSQLValidate' smart constructor.
data ProjectsLocationsSQLValidate =
  ProjectsLocationsSQLValidate'
    { _plsqlvXgafv          :: !(Maybe Xgafv)
    , _plsqlvUploadProtocol :: !(Maybe Text)
    , _plsqlvLocation       :: !Text
    , _plsqlvAccessToken    :: !(Maybe Text)
    , _plsqlvUploadType     :: !(Maybe Text)
    , _plsqlvQuery          :: !(Maybe Text)
    , _plsqlvProjectId      :: !Text
    , _plsqlvCallback       :: !(Maybe Text)
    }
  deriving (Eq, Show, Data, Typeable, Generic)


-- | Creates a value of 'ProjectsLocationsSQLValidate' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'plsqlvXgafv'
--
-- * 'plsqlvUploadProtocol'
--
-- * 'plsqlvLocation'
--
-- * 'plsqlvAccessToken'
--
-- * 'plsqlvUploadType'
--
-- * 'plsqlvQuery'
--
-- * 'plsqlvProjectId'
--
-- * 'plsqlvCallback'
projectsLocationsSQLValidate
    :: Text -- ^ 'plsqlvLocation'
    -> Text -- ^ 'plsqlvProjectId'
    -> ProjectsLocationsSQLValidate
projectsLocationsSQLValidate pPlsqlvLocation_ pPlsqlvProjectId_ =
  ProjectsLocationsSQLValidate'
    { _plsqlvXgafv = Nothing
    , _plsqlvUploadProtocol = Nothing
    , _plsqlvLocation = pPlsqlvLocation_
    , _plsqlvAccessToken = Nothing
    , _plsqlvUploadType = Nothing
    , _plsqlvQuery = Nothing
    , _plsqlvProjectId = pPlsqlvProjectId_
    , _plsqlvCallback = Nothing
    }


-- | V1 error format.
plsqlvXgafv :: Lens' ProjectsLocationsSQLValidate (Maybe Xgafv)
plsqlvXgafv
  = lens _plsqlvXgafv (\ s a -> s{_plsqlvXgafv = a})

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

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

-- | OAuth access token.
plsqlvAccessToken :: Lens' ProjectsLocationsSQLValidate (Maybe Text)
plsqlvAccessToken
  = lens _plsqlvAccessToken
      (\ s a -> s{_plsqlvAccessToken = a})

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

-- | The sql query to validate.
plsqlvQuery :: Lens' ProjectsLocationsSQLValidate (Maybe Text)
plsqlvQuery
  = lens _plsqlvQuery (\ s a -> s{_plsqlvQuery = a})

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

-- | JSONP
plsqlvCallback :: Lens' ProjectsLocationsSQLValidate (Maybe Text)
plsqlvCallback
  = lens _plsqlvCallback
      (\ s a -> s{_plsqlvCallback = a})

instance GoogleRequest ProjectsLocationsSQLValidate
         where
        type Rs ProjectsLocationsSQLValidate =
             ValidateResponse
        type Scopes ProjectsLocationsSQLValidate =
             '["https://www.googleapis.com/auth/cloud-platform",
               "https://www.googleapis.com/auth/userinfo.email"]
        requestClient ProjectsLocationsSQLValidate'{..}
          = go _plsqlvProjectId _plsqlvLocation _plsqlvXgafv
              _plsqlvUploadProtocol
              _plsqlvAccessToken
              _plsqlvUploadType
              _plsqlvQuery
              _plsqlvCallback
              (Just AltJSON)
              dataflowService
          where go
                  = buildClient
                      (Proxy :: Proxy ProjectsLocationsSQLValidateResource)
                      mempty